From 866067802cf5a44d44e46ee85c965b9665a5ed5b Mon Sep 17 00:00:00 2001 From: Garritt McCune Date: Wed, 1 Jul 2020 14:54:18 -0500 Subject: [PATCH] Added a readme file to the project. --- readme.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..45864ed --- /dev/null +++ b/readme.md @@ -0,0 +1,30 @@ +De-mutation Engine + +Please Note: This program assumes that Python 3 is installed on the system. + +Open a CMD prompt or Unix terminal emulator and change to the directory that contains the files +of the program. + +From there type "python main.py", depending on the way Python is installed you may have to type "python3 main.py". +However, this is only generally needed if both Python 2 and Python 3 are installed on the same system. + +Once you have ran the main.py file, it will prompt you for to enter the expression the student will use. + +Then the wrong response the student put for their answer. + +Following this will be the default starting values that variables found in the expression should use. + +These variables are currently grouped as Interest, Time or Installment. This makes it so the user doesn't have to +edit each variable every run one at a time. + +Next the tolerance for how much variance from the wrong response is entered. + +The program will then give you the option to modify individual properties for each variable found in the expression. +If you wish to change anything from their default values (entered above) now's the time to do so. Otherwise, simply press "enter" to continue. + +Finally, the program will begin running through all the mutations. This can take several minutes depending on the number of variables found +in the expression. Once the program is done it will display the number of results it found to the console and write the results to a +file in the working directory called "results.txt". + +The format for the output lines in the file is as follows: +"Result: for expression: ".