WRITE READMEs

Source: Udacity Front End Nanodegree program.

Who Is Your Documentation For?

Documentation is for:

Future YOU.
Co-workers, or Contributers.
End User. Therefore, Documentations should be clear, descriptive and easy to follow.

Anatomy Of A README

Title & Description.
- a sentece or two may be enough but be sure to provide clear explanation.
Information for undersanding your code/project. This may include:
- Installation instructions.
- Dependencies on other libraries, frameworks.
- Usage.
- Known bugs.
- Issues.
- Examples.
License.

Markdown

a light markup language often used for READMEs (though you'll find other use cases for it, too!).
Here is Markdown documentaion.

HTML

You can still use HTML in markdown when you could not accomplish something using markdown.

Dillinger

Markdown files use .md extension. It needs to be opened by specific software like Dillinger.
You can also open it in your text editors using some plugin or extension.
For VS Code you can install Markdown All In One extension.