Update README.md
This commit is contained in:
1 parent
6ee9d9e49a
commit
f56cd4f6ac
1 file changed
+3
-8
@@ -1,15 +1,10 @@
|
|||||||
# Schedule Generator
|
# 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.
|
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 algorithm reads student requests and generates a timetable for all requested classes and fills them with students, giving the students their own schedules.
|
||||||
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 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
|
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
|
$ ./tinker.py errors
|
||||||
```
|
```
|
||||||
|
|
||||||

|

|
||||||
Reference in new issue
Block a user