42-readme-generator
Installation
SKILL.md
42 README Generator
Generate well-structured README files for 42 School projects.
README Structure
Every 42 project README should include:
- Title & Tagline (with emojis)
- Description - Overview, problem, key challenge
- Technologies & Concepts - What's used and learned
- How It Works - Visual explanations with ASCII diagrams
- Architecture - Data structures, modules
- Source Code Structure - Directory tree
- Instructions - Build, run, test
- Technical Challenges - Problems and solutions (collapsible)
- Useful Links - Guides and resources
- License - Academic disclaimer