From f56cd4f6acad7ad593318023d16f3ae65455117f Mon Sep 17 00:00:00 2001 From: Braeden Sowinski Date: Wed, 22 Jun 2022 11:16:21 -0700 Subject: [PATCH] Update README.md --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 01a259f..46f531c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,10 @@ # Schedule Generator Hello there! This is the standalone repository for the schedule generator from my [school-management-api](https://github.com/SowinskiBraeden/school-management-api) project. -The algorithms have been moved out of `tinker.py` into its own python -script. Version 1 and 2 are removed. The script can be found in the `/scheduleGenerator` folder. The algorithm has come a long way. -Using real 2018 course selection data from my school, enabling me to better test the script. -V3 has a entirely different approach from V1 and V2, that you can read about at the top of -the function in [`generator.py`](/scheduleGenerator/generator.py). The function is broken up into 6 steps, each step is labeled within -the function with a comment, giving a brief explination of what that step contributes to the -algorithm. +The algorithm reads student requests and generates a timetable for all requested classes and fills them with students, giving the students their own schedules. +The algorithm has been moved out of `tinker.py` into its own python script. Version 1 and 2 are removed and the script can be found in the `/scheduleGenerator` folder. The algorithm has come a long way; using real 2018 course selection data from my school, enabling me to better test the script. V3 has a entirely different approach from V1 and V2, that you can read about at the top of the function in [`generator.py`](/scheduleGenerator/generator.py). The function is broken up into 6 steps, each step is labeled within the function with a comment, giving a brief explination of what that step contributes to the algorithm. This is the output after running it with the following command ``` @@ -24,4 +19,4 @@ A more in depth error log can be read with the additional argument $ ./tinker.py errors ``` -![preview](/preview/error-preview.png) \ No newline at end of file +![preview](/preview/error-preview.png)