A short description of the project.
0.0.0
major.minor.micro
major-changes.feature-changes.bug-fixes
A list of features
A short example.
show an example
Provide code examples and explanations of how to get the project/application up and running.
If python, an example could be
python setup.py install
usage: some-proj.py [-h] ...
short description
positional arguments:
optional arguments:
-h, --help show this help message and exit
Provide a link to the documentation.
Describe and show how to run the tests with code examples.
List of code requirements or point to a requirements.txt file.
A short description of the license.
Explain how to help and contribute to the project.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
name
email