2013-01-07 23:50:12 +00:00
|
|
|
== README
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
This README would normally document whatever steps are necessary to get the
|
|
|
|
|
application up and running.
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
Things you may want to cover:
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
* Ruby version
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
* System dependencies
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
* Configuration
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
* Database creation
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
* Database initialization
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
* How to run the test suite
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
* Services (job queues, cache servers, search engines, etc.)
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
* Deployment instructions
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
* ...
|
2011-09-12 14:30:45 +00:00
|
|
|
|
2013-01-07 23:50:12 +00:00
|
|
|
If you plan to generate application documentation with `rake doc:app` this file
|
|
|
|
|
is expected to be `README.rdoc`, otherwise please feel free to rename it and use
|
2013-01-05 23:42:57 +00:00
|
|
|
a different markup language.
|
