diff --git a/README.md b/README.md index 29481dc..3a62bdc 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # ib-clearance -ib-clearance is a program which helps schools manage the entrance and exiting of their IBDP students. Due to the unique nature of IB students' timetables, the program helps check individual timetables and give clearance to students who have finished for the day. +ib-clearance is a program which helps schools manage the entrance and exiting of their IB Diploma Program students. Due to the unique nature of IB students' timetables, the program helps to automatically check individual timetables and give clearance to students who have finished for the day. ## Building The code is currently designed to run on Python 3.6.*. -I recommend building executables with `pyinstaller` with `pyinstaller --onefile ib-clearance.py`. +Binaries can be built using the `pyinstaller` package (`pyinstaller --onefile ib-clearance.py`). ## Database specification -The program requires a SQLite database `database.db` in the working directory, containing info for all classes. +The program requires a SQLite database `database.db` in the working directory, containing data for all classes. `database.db` must contain: