This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
Copy all .dist. files and remove “dist” Dist files are configuration files that a require configuration for your local environment.
-
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
-
…
Please feel free to use a different markup language if you do not plan to run rake doc:app.