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