== README
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
-
ImageMagick (https://www.imagemagick.org/)
sudo apt-get update
sudo apt-get install imagemagick
- Graphviz (https://www.graphviz.org/) - Development Environment only
sudo apt-get install aptitude
sudo aptitude install graphviz
-
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.