Add: C-Shell tutorial to Shell section #1651
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a new C-Shell tutorial resource to the "Build your own Shell" section of the README. The tutorial is a GitHub repository that provides step-by-step documentation for building a POSIX-oriented shell implementation in C.
Key Changes:
- Adds a single new entry linking to the C-Shell tutorial repository in the Shell section
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * [**C**: _Writing a UNIX Shell_](https://indradhanush.github.io/blog/writing-a-unix-shell-part-1/) | ||
| * [**C**: _Build Your Own Shell_](https://github.com/tokenrove/build-your-own-shell) | ||
| * [**C**: Write a shell in C](https://danishpraka.sh/posts/write-a-shell/) | ||
| * [**C**: _C-Shell (A lightweight, POSIX-oriented shell implementation in C)_](https://github.com/JeetMajumdar2003/C-Shell) |
There was a problem hiding this comment.
The title format is inconsistent with other entries in this section. Most entries use concise titles without parenthetical descriptions or detailed explanations. For example, other entries use titles like "Write a shell in C", "Build Your Own Shell", or "Writing a UNIX Shell".
The current title "C-Shell (A lightweight, POSIX-oriented shell implementation in C)" includes descriptive content in parentheses that breaks from the established pattern. Consider simplifying to just "C-Shell" or "Build Your Own C-Shell" to match the repository's style guide where titles are brief and action-oriented.
| * [**C**: _C-Shell (A lightweight, POSIX-oriented shell implementation in C)_](https://github.com/JeetMajumdar2003/C-Shell) | |
| * [**C**: _C-Shell_](https://github.com/JeetMajumdar2003/C-Shell) |
| * [**C**: _Let's build a shell!_](https://github.com/kamalmarhubi/shell-workshop) | ||
| * [**C**: _Writing a UNIX Shell_](https://indradhanush.github.io/blog/writing-a-unix-shell-part-1/) | ||
| * [**C**: _Build Your Own Shell_](https://github.com/tokenrove/build-your-own-shell) | ||
| * [**C**: Write a shell in C](https://danishpraka.sh/posts/write-a-shell/) |
There was a problem hiding this comment.
The title should be wrapped in underscores for italic formatting to maintain consistency with other entries in the README. Most entries follow the pattern [**Language**: _Title_](URL) where the title is italicized using underscores. Compare with lines 358-361 and 364-365 which all use this format.
| * [**C**: Write a shell in C](https://danishpraka.sh/posts/write-a-shell/) | |
| * [**C**: _Write a shell in C_](https://danishpraka.sh/posts/write-a-shell/) |
thetoasta
left a comment
There was a problem hiding this comment.
I don't have permissions to merge.
BYO-X aims towards tutorials, and simple starting point. The addition you linked (which was still really good) was just a complete shell. Following the pattern for the titles, the extra description at the end doesn't follow the pattern. Overall would be a good addition, but it really just needs to be a tutorial or a starting point.
Adds the C-Shell repository (https://github.com/JeetMajumdar2003/C-Shell) to the "Build your own
Shell" section in the README.Features:
Build from Scratchguide and architecture documentation (docs/BUILD_FROM_SCRATCH.mdanddocs/ARCHITECTURE.md).Checklist (included in PR):
ISSUE_TEMPLATE fields: