Title of my project
- Write a short abstract for your project. What does it do or solve, or what questions is it attempting to address? What information is included in your documentation and how should others navigate this information?*
Project attributes and methods
What reference information will make your project ready for scientific, public, or computational consumption? You don't have to reinvent the wheel...check out the resources and initiatives below.
Use and Contribute
Describe how others can use and contribute to your project. Consider including links to:
- Tutorials and how to guides
- An issues tracker
- Source code
License
Without a standard license, others will not know how and if they can reuse and redistribute your work. You might find these resources helpful: