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 Tutorial section to Readme.md, placed between the existing "How It Works" section and the "Build" section.
  • The tutorial contains 7 numbered subsections covering every major concept in relay.c: the Client struct and slot array, socket setup, the select() event loop, accepting connections, broadcasting messages, the /nick command, and the live dashboard.
  • All code snippets are quoted verbatim from relay.c — no invented pseudo-code.

Test plan

  • Verify the rendered Readme on GitHub looks correct (headings, code blocks, ordering).
  • Confirm the Tutorial section appears after "How It Works" and before "Build".
  • Check that every code snippet matches the corresponding lines in relay.c.

🤖 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