aboutsummaryrefslogtreecommitdiffstats
path: root/guides/code/getting_started/README.rdoc
blob: 8d1b0f42e5fb0df421694c9c7a364e9e107b5b4d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
== README

This README would normally document whatever steps are necessary to get the
application up and running.

Things you may want to cover:

* Ruby version

* System dependencies

* Configuration

* Database creation

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...

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.