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
-
...
Review Code Checked at:
rails_best_practices -f html . => warnings
brakeman -o brakeman-report.html => 0 warnings
rubocop --format html -o rubocop-report.html => warnings
rails traceroute > traceroute-report.txt =>
rubycritic --no-browser -f html . =>