README.template 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  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. Describe the point of the project here.
  20. -------------------------------------------------------------------------------
  21. Dependencies:
  22. List any dependencies here.
  23. -------------------------------------------------------------------------------
  24. Documentation
  25. Any notes about documentation--such as a link to a page in the Book of Dojo,
  26. documentation state, etc.--should go here.
  27. -------------------------------------------------------------------------------
  28. Installation instructions
  29. Use this to explain in detail what a person needs to do in order to use this
  30. project. Include URLs for grabbing source, URLs for any dependencies, etc.
  31. Also be sure to include any additional information, such as where to place
  32. CSS files, images, other media, etc. The goal is that someone reading this
  33. file can follow your instructions and be using this project within minutes.
  34. -------------------------------------------------------------------------------
  35. Additional Notes
  36. Anything else you think is of interest (for example, object hierarchy) should
  37. be placed here.