<img src=“https://api.codeclimate.com/v1/badges/02a925f8fcab4b681b5f/maintainability” /> <img src=“https://api.codeclimate.com/v1/badges/02a925f8fcab4b681b5f/test_coverage” /> <img src=“https://travis-ci.org/rileydcampbell/cs169-parser.svg?branch=master” alt=“Build Status” />
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.