Created
January 3, 2019 14:54
-
-
Save taulutwashi/52e61e705acce2b34a6d7cf98fac33df to your computer and use it in GitHub Desktop.
This is the template for project documentation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
$project | |
======== | |
$project will solve your problem of where to start with documentation, | |
by providing a basic explanation of how to do it easily. | |
Look how easy it is to use: | |
import project | |
# Get your stuff done | |
project.do_stuff() | |
Features | |
-------- | |
- Be awesome | |
- Make things faster | |
Installation | |
------------ | |
Install $project by running: | |
install project | |
Contribute | |
---------- | |
- Issue Tracker: github.com/$project/$project/issues | |
- Source Code: github.com/$project/$project | |
Support | |
------- | |
If you are having issues, please let us know. | |
We have a mailing list located at: project@google-groups.com | |
License | |
------- | |
The project is licensed under the BSD license. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment