aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakobS1n <jaste1@outlook.com>2016-03-19 17:10:31 +0100
committerJakobS1n <jaste1@outlook.com>2016-03-19 17:10:31 +0100
commitbf71712d8b35b128aa6a1ee565fe0af6639311df (patch)
treee84dd83f51a0c0ecf901aabc8201f47916858d06
parent010d6961537856039923c7fb47cafc1a36f7a499 (diff)
downloadmath-draw-bf71712d8b35b128aa6a1ee565fe0af6639311df.tar.gz
math-draw-bf71712d8b35b128aa6a1ee565fe0af6639311df.zip
Added text
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6ea8fc1..89d6581 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
-# math-draw \ No newline at end of file
+# math-draw
+A simple program for drawing mathematical figures
+
+## Requirements
+ - Tested with Python 2.7.10
+ - As far as i know this is the only requirements to run this program
+
+## Launch
+Navigate to the folder with math-draw.py, and execute this:
+```
+ python math-draw.py
+```
+
+## Options
+When the program is started it will start to draw a figure, if the window is in focus you can use this hotkeys to do different things.
+- Left Arrow: Decrease how many points that is on the circlearc
+- Right Arrow: Increase how many points that is on the circlearc
+- Up Arrow: Increase multiplier
+- Down Arrow: Decrease multiplier
+- q: Quit
+- d: Toggle draw points on circlearc
+- a: Toggle drawing animation
+- t: Toggle handdrawing animation
+