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, placed between the existing "How It Works" and "Build" sections.
  • The tutorial is structured as 7 numbered subsections, each explaining a distinct concept or pipeline stage in cshell.c.
  • Every code snippet is taken verbatim from the actual source — no invented pseudo-code.

Subsections added

  1. Constants and the Trim Helper
  2. The Read-Eval Loop
  3. Built-in Commands (cd, exit)
  4. Splitting the Command Line into Pipeline Stages
  5. Forking and Wiring the Pipe Chain
  6. Parsing a Single Segment — Arguments and Redirection
  7. Applying Redirection and Executing

Test plan

  • Review that all code snippets match the source in cshell.c exactly.
  • Confirm section ordering: How It Works → Tutorial → Build → Run → Controls.
  • Read through each subsection for accuracy and clarity.

🤖 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