Skip to content

docs: add Tutorial section to README#2

Open
Oval17 wants to merge 1 commit into
mainfrom
add-tutorial
Open

docs: add Tutorial section to README#2
Oval17 wants to merge 1 commit into
mainfrom
add-tutorial

Conversation

@Oval17
Copy link
Copy Markdown
Member

@Oval17 Oval17 commented Jun 3, 2026

Summary

  • Adds a step-by-step Tutorial section to Readme.md between the existing "How It Works" section and the "Build" section.
  • The tutorial is split into 6 numbered subsections covering: simulation constants & state arrays, the driven anchor node, Verlet integration with damping and gravity, distance constraint solving, rasterising nodes into a character buffer, and frame rendering & timing.
  • Every code snippet is taken verbatim from rope.c — no invented pseudo-code.

Test plan

  • Read through each subsection and verify every code snippet matches the corresponding lines in rope.c.
  • Build and run the program (gcc rope.c -o rope -lm && ./rope) to confirm the described behaviour matches the tutorial text.
  • Check that the rest of the README is unchanged.

🤖 Generated with Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant