This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version 2.5.1
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...
$ bundle install --path=vendor/bundle
$ yarn install
$ bin/webpack
$ bundle exec rails s
$ yardoc 'necessary files'
$ yard server