This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
ruby 2.2
-
Rails version
Rails 4.2.1
-
System dependencies
-
Configuration
-
Database creation
Product table rails g scaffold Product \ title:string description:text image_url:string price:decimal rake db:migrate
-
Cart
rails g scaffold Cart rake db:migrate
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
…
-
Pages
/products /store /carts /line_items
Please feel free to use a different markup language if you do not plan to run rake doc:app
.