added README.md

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e8b8416
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# LibrePlanet schedule generator
+
+## dependencies
+
+- nose
+- markdown
+
+## on GNU/Linux
+
+Install `virtualenv` and python dev. package.
+
+On a Debian based distribution, do:
+
+    # aptitude install virtualenv python-dev
+
+## set up environment
+
+    $ git clone git://notabug.org/rsd/lpschedule-generator.git
+
+Setup virtual environment:
+
+    $ cd lpschedule-generator
+    $ virtualenv .
+
+Activate the virtual environment:
+
+    $ source bin/activate
+
+Install `lpschedule-generator`:
+
+    $ python setup.py install
+
+This will install all the dependencies.