Block 153: Writing a Professional README
Document your project so others can understand and run it.
Concepts
- README.md sections: title, description, demo, installation, usage, examples, limitations
- Markdown formatting: headers, code blocks, tables, badges
- Screenshots and sample output
- Contributing section and license
Code Examples
See exercise below.
Exercise
Write a complete README.md for your project with all sections. Include at least one code example and one screenshot/output sample. Review someone else's GitHub README and identify what makes it good or bad.
Homework
Ask a friend or colleague to follow your README from scratch. Note every point where they got confused.