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
# deploy local ./launch_localhost.sh
# deploy bundle update git push heroku master
# update ruby version rbenv install 2.6.3
-
…
Please feel free to use a different markup language if you do not plan to run rake doc:app.