README: add basic documentation

diff --git a/README b/README
index dd6f8da..08fa377 100644 (file)
--- a/README
+++ b/README
@@ -11,3 +11,33 @@ In a structured and sane API with port nanmes/numbering that match boards.
 
 The intent is to make it easier for developers and sensor manufacturers to map
 their sensors & actuators on top of Intel hardware.
+
+=== ENV REQUIREMENTS ===
+
+node.js 0.10.26
+python 3.3.5
+swig-v8 3.0.1 (if you want node.js to work you need to use swig-v8)
+I'm using f31c1dce7a45c4b8ed7e6ff845f4c74539e056f1 from
+http://github.com:oliver----/swig-v8
+
+=== COMPILING ===
+
+if swig-v8 is not in your default path you can try run cmake with
+"-DCMAKE_PREFIX_PATH="/path/to/swig-v8"
+
+mkdir build/
+cmake ..
+make
+
+Install is currently unsuported. Javascript and python modules will be in
+build/src/{javascript, python}
+
+=== USING ===
+
+see examples/
+
+for node.js make sure that maajs.node is in the current dir and set export
+NODE_PATH=.
+
+python2/3 should both work, although testing is done on python3 exclusively.
+Node.js bindings may be dodgy, I'm so far unclear of how good swig-v8 is.