Markdown

We use markdown files as a simple way to write documentation, and there is always a readme.md in the root directory of any project. Each major section of the project might have additional notes.

I use headings, bold, italics, hyperlinks etc. You can do more complex things with markdown, but its supposed to be simple.

Edit the readme.md file as you go along, someone browsing your repo should be able to understand the repo fully based on what is written here. Typically, you should have the following headings.

1. Title

2. Objective of the project, what problem the project will address.

3. How users can get started with the project, dependencies, environment.

4. Where users can get help with the project.

5. Who maintains and contributes to the project. Do not post e-mail addresses.

6. If there is major documentation in sections, you could link to it from here.

I am not a fan of badges, etc. but feel free to add.