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-22 05:12:29 +00:00
|
|
|
|
|
|
|
|
Please feel free to use a different markup language if you do not plan to run
|
|
|
|
|
<tt>rake doc:app</tt>.
|
