Readme Templates

For your open-source projects.

Categories

• End user product: this template describes a ready to use product. It includes the features, intallation instructions, configuration, usage examples, screenshots, backlog, contribution instructions and license.
• Developer tool: this template describes a tool which can be used by developers to make other products. It includes the features, intallation instructions with requirements, configuration, usage (development / deployment), screenshots, backlog, contribution instructions and license.

Usage

Download the zip or clone this project and copy - paste the readme you want in your project.

git clone https://github.com/jsulpis/readme-templates.git

Or

Open the README.md file in the GitHub explorer, click on "Raw" on the top of the preview and copy - paste the markdown code in your own readme.

Contributing

Contributions are welcome ! If you improve a template, feel free to share it.

1. Fork the project (https://github.com/jsulpis/readme-templates/fork)
2. Clone it on your machine (git clone https://github.com/yourname/readme-templates.git)
3. Create your feature branch (git checkout -b feature/awesomeFeature)
4. Commit your changes (git commit -am 'Add my awesome feature')
5. Push your branch (git push origin feature/awesomeFeature)
6. Open a new Pull Request

References

Awesome README

Dan Bader - How to write a great README for your GitHub project

GlBj/MyWebpack README.md