This README would normally document whatever steps are necessary to get the application up and running.
Useful commands
-
webpack in development:
webpack --config config/webpack/development.config.js --watch --colors
Things you may want to cover:
-
Rails version => 4.2.7 -
Ruby version => 2.3.0 -
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.