diff --git a/readme.md b/readme.md index 30fb427a330e22d93f5b97d9efd5c660bd481cea..15a05485b22e2680834991bb4715ed01e76aa21c 100644 --- a/readme.md +++ b/readme.md @@ -6,6 +6,9 @@ Python implementation of a "Network Flow" algorithm. Implements both "Ford-Fulkerson" and "Simplex" versions. +This program uses both the "Simplex" and "Graph Library" assignments from earlier in the semester, included as git +submodules. + ## Python Environment This project is tested using Python3.7. @@ -26,7 +29,10 @@ Once created, load this environment with `source .venv/bin/activate` on Linux or Run the program via `python ./main.py` while at the `python` directory. ### Expected Output -None so far. +Will prompt the user to run the program as either "Ford Fulkerson" or "Simplex". + +Both will output the initial graph, as well as the final output. Ford Fulkerson will also output each iteration of +steps, where the final iteration is the end product. ## Running Tests