<a href=“codeclimate.com/repos/53fe7b186956804b2a00e6ad/feed”><img src=“codeclimate.com/repos/53fe7b186956804b2a00e6ad/badges/0179a4cd8f184f3861ec/gpa.svg” /></a>
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
-
…
Please feel free to use a different markup language if you do not plan to run rake doc:app.