From 91bb56149f9883bd001ee25c158983e420132bf6 Mon Sep 17 00:00:00 2001 From: Braeden Sowinski Date: Tue, 21 Jun 2022 22:47:07 -0700 Subject: [PATCH] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index de79cc5..46f85ba 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # 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 their own python -script. Version 1 and 2 are remoed. This is in the `/scheduleGenerator` folder. The algorithm has come a long way. -Using real 2018 course selection data from my school I am able to test the script to its full potential. +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`. The function is broken up into 6 steps, each step is labeled within +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.