| 1 | # README |
| 2 | |
| 3 | This README would normally document whatever steps are necessary to get the |
| 4 | application up and running. |
| 5 | |
| 6 | Things you may want to cover: |
| 7 | |
| 8 | * Ruby version |
| 9 | |
| 10 | * System dependencies |
| 11 | |
| 12 | * Configuration |
| 13 | |
| 14 | * Database creation |
| 15 | |
| 16 | * Database initialization |
| 17 | |
| 18 | * How to run the test suite |
| 19 | |
| 20 | * Services (job queues, cache servers, search engines, etc.) |
| 21 | |
| 22 | * Deployment instructions |
| 23 | |
| 24 | * ... |