| 2150 |
mathias |
1 |
-------------------------------------------------------------------------------
|
|
|
2 |
Project Name
|
|
|
3 |
-------------------------------------------------------------------------------
|
|
|
4 |
Version X.XXX
|
|
|
5 |
Release date: MM/DD/YYYY
|
|
|
6 |
-------------------------------------------------------------------------------
|
|
|
7 |
Project state:
|
|
|
8 |
prototype | expermental | beta | stable | production
|
|
|
9 |
-------------------------------------------------------------------------------
|
|
|
10 |
Credits
|
|
|
11 |
Author one (author contact info)
|
|
|
12 |
Author two (author contact info)
|
|
|
13 |
-------------------------------------------------------------------------------
|
|
|
14 |
Project description
|
|
|
15 |
|
|
|
16 |
Describe the point of the project here.
|
|
|
17 |
-------------------------------------------------------------------------------
|
|
|
18 |
Dependencies:
|
|
|
19 |
|
|
|
20 |
List any dependencies here.
|
|
|
21 |
-------------------------------------------------------------------------------
|
|
|
22 |
Documentation
|
|
|
23 |
|
|
|
24 |
-------------------------------------------------------------------------------
|
|
|
25 |
Installation instructions
|
|
|
26 |
|
|
|
27 |
Use this to explain in detail what a person needs to do in order to use this
|
|
|
28 |
project. Include URLs for grabbing source, URLs for any dependencies, etc.
|
|
|
29 |
Also be sure to include any additional information, such as where to place
|
|
|
30 |
CSS files, images, other media, etc. The goal is that someone reading this
|
|
|
31 |
file can follow your instructions and be using this project within minutes.
|
|
|
32 |
-------------------------------------------------------------------------------
|
|
|
33 |
Additional Notes
|
|
|
34 |
|
|
|
35 |
Anything else you think is of interest (for example, object hierarchy) should
|
|
|
36 |
be placed here.
|