Added a readme file to the project.

2020-07-01 14:54:18 -05:00
parent fe30f0c6ba
commit 866067802c
1 changed files with 30 additions and 0 deletions
@@ -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: <Wrong Answer> for expression: <Possible Equation>".