aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTa180m2019-05-07 13:14:03 -0500
committerGitHub2019-05-07 13:14:03 -0500
commit59f845844a4c94a8f13d89f7f7e297ca23f710ec (patch)
tree07ff9db42ca710f7099bc2fa6eaaabfb019ac69a
parent17f6fc4372eb74761c95d25d8bbcb60d5b5fc865 (diff)
Update README.md
Added more documentation
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index da5cfa8..b7d190d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
# Gimkit
Using a Dynamic Programming algorithm to search for the optimal Gimkit strategy.
+
+## How to use
+`// Initial conditions
+// Change these values to alter the initial state
+ll start = 0, goal = 1e10;
+int max_it = 150; // Number of iterations to solve
+int MPQ = 0, SB = 0, M = 0; // Initial upgrade status
+int D = 0, R = 0, B1 = 0, B2 = 0; // Initial power-up status`
+
+Change these values to alter the initial state:
+* **start** - Starting amount of money
+* **goal** - Ending amount of money
+* **max_it** - The maximum number of iterations to solve
+* **MPQ** - The initial level of the money per question upgrade (Starts from 0)
+* **SB** - The initial level of the streak bonus upgrade (Starts from 0)
+* **M** - The initial level of the multiplier upgrade (Starts from 0)
+* **D** - The status of the discounter power-up (0 is unpurchased, 1 is purchased and used)
+* **R** - The status of the rebooter power-up (0 is unpurchased, 1 is purchased and used)
+* **B1** - The status of the mini bonus power-up (0 is unpurchased, 1 is purchased and unused, 2 is used)
+* **B2** - The status of the mega bonus power-up (0 is unpurchased, 1 is purchased and unused, 2 is used)