This application started as a small project to get some task done in our lab. Currently is just a basic app that list workstations, graphic cards, monitors and Operating systems distributions in use. These can be integrated in a review or report that keeps change done in the parts of the Workstation.
Then it can generate a PDF file of one sheet per workstation, every row denote the state of a Workstation in a specific date, so you can keep track of it.
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.