1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/guides/code/getting_started/README.rdoc

28 lines
565 B
Text
Raw Normal View History

2013-01-07 18:50:12 -05:00
== README
2013-01-07 18:50:12 -05:00
This README would normally document whatever steps are necessary to get the
application up and running.
2013-01-07 18:50:12 -05:00
Things you may want to cover:
2013-01-07 18:50:12 -05:00
* Ruby version
2013-01-07 18:50:12 -05:00
* System dependencies
2013-01-07 18:50:12 -05:00
* Configuration
2013-01-07 18:50:12 -05:00
* Database creation
2013-01-07 18:50:12 -05:00
* Database initialization
2013-01-07 18:50:12 -05:00
* How to run the test suite
2013-01-07 18:50:12 -05:00
* Services (job queues, cache servers, search engines, etc.)
2013-01-07 18:50:12 -05:00
* Deployment instructions
2013-01-07 18:50:12 -05:00
* ...
2013-01-07 18:50:12 -05: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
a different markup language.