Documenting your projects on GitHub

Documentation is as important as your code! Only good documentation will allow others to understand how your code works and actually be able to run it themselves.

Github has some excellent tips on how to document your projects on GitHub. We recommend that you give it a read and then come back here for some more tips and tricks.

Markdown Syntax

The github README page uses Mardown as the formatting language. Mardown is a lightweight and easy-to-use syntax for styling all forms of writing.

• GitHub Guides - Mastering Markdown
• Cheat Sheet - Save as bookmark!