README.rdoc 478 B

12345678910111213141516171819202122232425262728
  1. == README
  2. This README would normally document whatever steps are necessary to get the
  3. application up and running.
  4. Things you may want to cover:
  5. * Ruby version
  6. * System dependencies
  7. * Configuration
  8. * Database creation
  9. * Database initialization
  10. * How to run the test suite
  11. * Services (job queues, cache servers, search engines, etc.)
  12. * Deployment instructions
  13. * ...
  14. Please feel free to use a different markup language if you do not plan to run
  15. <tt>rake doc:app</tt>.