commit 7897510be55cfcd0028d3210e3fa0d71aafc95e2
parent 2894a9124753e41045ae41a08370089010ef84d0
Author: Stefan Koch <taikano@lavabit.com>
Date: Tue, 11 Jun 2013 11:13:01 +0200
added readme info
Diffstat:
1 file changed, 26 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,29 @@
gestures
========
-A small tool for tracking gestures with your webcam and executing global commands (like volume up)
+Gestures is a lightweight tool for tracking gestures with your webcam and
+executing global commands (like volume up).
+
+
+Requirements
+------------
+Python2 is required to run gestures.
+
+The following non-standard libraries are required for Python:
+- opencv
+- ghmm
+- numpy
+
+Configuration
+-------------
+You can configure own gestures in the files `models.py`.
+At the top, there is a section `gestures` which is defined as a list of
+tuples containing the gesture and the command to be executed. The gesture
+is given as a list of movements, e.g. `[UP, DOWN, UP]` and a valid
+command for `subprocess`. The latter one is a list of command parts where
+you split your command at spaces, i.e. `firefox -safe-mode` would become
+`['firefox', '-safe-mode']`.
+
+Pay attention to the fact that there are no quotation marks around directions
+like `UP` and `DOWN`, because these are special keywords by gestures.
+
