Skip to content

Generate README documentation for 1337 curriculum projects - #1

Draft
ayfadli with Copilot wants to merge 3 commits into
mainfrom
copilot/generate-readme-for-folders
Draft

Generate README documentation for 1337 curriculum projects#1
ayfadli with Copilot wants to merge 3 commits into
mainfrom
copilot/generate-readme-for-folders

Conversation

Copilot AI commented Jan 30, 2026

Copy link
Copy Markdown

Adds structured README.md files for each project folder documenting their role in the 1337 (42 Network) curriculum and usage instructions.

Structure

Created 3 project directories with comprehensive documentation:

  • libft/ - C library project

    • Makefile with standard rules (all, clean, fclean, re)
    • README documenting 23 libc function implementations
  • ft_printf/ - printf reimplementation

    • Makefile with standard rules
    • README documenting format specifiers and usage examples
  • Born2beRoot/ - System administration project

    • README documenting LVM/SSH/UFW configurations with verification commands
    • Sample configs.txt for reference

README Format

Each README follows consistent structure:

  • Title: Project name
  • Description: Curriculum context and learning objectives
  • Usage: Build instructions (C projects) or configuration details (SysAdmin)

For C projects, all Makefile rules are documented with explanations. For Born2beRoot, includes specific configuration values (port 4242, LVM setup, firewall rules) and verification commands.

Root README updated with navigation links and project overview.

Original prompt

Scan repo folders. For each, generate a README.md. 1. Content: Title, Description (role in 1337 curriculum), and Usage. 2. Logic:

C Projects: If Makefile exists, document make rules.

Python: If .py exists, document python3 usage.

SysAdmin: For Born2BeRoot, list LVM/SSH/UFW configs. 3. Action: Open a PR with the files.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits January 30, 2026 09:26
Co-authored-by: ayfadli <85910156+ayfadli@users.noreply.github.com>
…nk lines

Co-authored-by: ayfadli <85910156+ayfadli@users.noreply.github.com>
Copilot AI changed the title [WIP] Add README.md files for each folder in the repo Generate README documentation for 1337 curriculum projects Jan 30, 2026
Copilot AI requested a review from ayfadli January 30, 2026 09:32
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.

2 participants