37 lines
1.6 KiB
Text
37 lines
1.6 KiB
Text
|
-------------------------------------------------------------------------------
|
||
|
|
Project Name
|
||
|
|
-------------------------------------------------------------------------------
|
||
|
|
Version X.XXX
|
||
|
|
Release date: MM/DD/YYYY
|
||
|
|
-------------------------------------------------------------------------------
|
||
|
|
Project state:
|
||
|
|
prototype | experimental | beta | stable | production
|
||
|
|
-------------------------------------------------------------------------------
|
||
|
|
Credits
|
||
|
|
Author one (author contact info)
|
||
|
|
Author two (author contact info)
|
||
|
|
-------------------------------------------------------------------------------
|
||
|
|
Project description
|
||
|
|
|
||
|
|
Describe the point of the project here.
|
||
|
|
-------------------------------------------------------------------------------
|
||
|
|
Dependencies:
|
||
|
|
|
||
|
|
List any dependencies here.
|
||
|
|
-------------------------------------------------------------------------------
|
||
|
|
Documentation
|
||
|
|
|
||
|
|
-------------------------------------------------------------------------------
|
||
|
|
Installation instructions
|
||
|
|
|
||
|
|
Use this to explain in detail what a person needs to do in order to use this
|
||
|
|
project. Include URLs for grabbing source, URLs for any dependencies, etc.
|
||
|
|
Also be sure to include any additional information, such as where to place
|
||
|
|
CSS files, images, other media, etc. The goal is that someone reading this
|
||
|
|
file can follow your instructions and be using this project within minutes.
|
||
|
|
-------------------------------------------------------------------------------
|
||
|
|
Additional Notes
|
||
|
|
|
||
|
|
Anything else you think is of interest (for example, object hierarchy) should
|
||
|
|
be placed here.
|