This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
NOTE: At the time of updating this README, entering student details is broken for unknown reasons. It was working a few days ago. I assume there is some change I made ignorantly and now have to determine the fix.
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...