diff --git a/READEME.md b/READEME.md new file mode 100644 index 0000000..56f9288 --- /dev/null +++ b/READEME.md @@ -0,0 +1,21 @@ +# Schedule Generator Capstone + +This is the final build of the Schedule Generator Application. + +### Download + +1. Go to the [Github Repository](https://github.com/SowinskiBraeden/ScheduleGeneratorEXE) + +2. Click on the green code button. +[code](/example_images/code.png) + +3. CLick ` Download ZIP ` +[download](/example_images/download.png) + +4. Extract the Files + +5. Run the ` ScheduleGenerator.exe ` file. This may prompt a warning from windows to not run it, click ` Run Anyway ` to start the app. + +Select the [course selection data file](/example/course_selection_data_example.csv) from the ` example ` folder and click ` Generate `. + +Wait for the process to finish and an ` output ` folder will appear, then open the ` /output/final ` or the ` /outout/raw/csv ` to see output files. diff --git a/example_images/code.png b/example_images/code.png new file mode 100644 index 0000000..7e8bee9 Binary files /dev/null and b/example_images/code.png differ diff --git a/example_images/download.png b/example_images/download.png new file mode 100644 index 0000000..c03c470 Binary files /dev/null and b/example_images/download.png differ