Add relevant badges here.
- Introduction
- Main Features
- Prerequisites
- Install
- Usage
- README Examples
- Maintainers
- Contributing
- License
Your README file is normally the first entry point to your code. It should tell people why they should use your module, how they can install it, and how they can use it. Standardizing how you write your README makes creating and maintaining your READMEs easier. Great documentation takes work!
Your documentation is complete when someone can use your module without ever having to look at its code. This is very important. This makes it possible for you to separate your module's documented interface from its internal implementation (guts). This is good because it means that you are free to change the module's internals as long as the interface remains the same.
Remember: the documentation, not the code, defines what a module does.
Writing READMEs is way too hard, and keeping them maintained is difficult. By offloading this process - making writing easier, making editing easier, making it clear whether or not an edit is up to spec or not - you can spend less time worrying about whether or not your initial documentation is good, and spend more time writing and using code.
- List item
- List item
- List item
- List Item
- List Item
- Another cool feature
Enter list of prerequisites to run the project.
This module depends upon a knowledge of python or something.
$ npm install --global standard-readme-specUse this template to get started with your own README file.
$ pip install djangoAnd then run the following command to start the project:
$ command-name startproject \
more stuff
more stuffThree README examples are provided here.
By having a standard, users can spend less time searching for the information they want. They can also build tools to gather search terms from descriptions, to automatically run example code, to check licensing, and so on.
Link to the GitHub profile of the maintainer of this project.
Provide instructions how to contribute to the project.