diff --git a/readme.md b/readme.md index cf601f64f21031ab7da6fe95d2146bcc084065b1..62e68a7aa86ebb6fe36f2597f3e51a46797d46e3 100644 --- a/readme.md +++ b/readme.md @@ -31,8 +31,21 @@ Once created, load this environment with `source .venv/bin/activate` on Linux or ## Running the Program Run the program via `python ./main.py` while at the project root. +Note: Items in the item set are defined by "total benefit" and "total weight/cost". Then the per-weight value of the +item is calculated from this, via `total benefit / total cost`. The user only ever inputs "total benefit" and "total +cost" values. + ### Expected Output -None so far. +On launch, a UserInterface menu will start up. + +At all times, hitting option 1 should display knapsack variables. + +Option 2 will open a submenu to set/change these knapsack variables. Note that the "item set" can either be read in from +a JSON file, or entered manually, item by item, through the console. Just select the correct option in the submenu for +each. + +Finally, option 3 will solve for the given knapsack variables. Solutions are only output for an item set of 1 or more +items, and a max weight greater than 0. ## Running Tests