Add README

1 files changed, 38 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..aae32739
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+Reel2Bits
+=====================
+
+# Versions requirement
+ - Python >= 3.3 (3.0, 3.1, 3.2 not supported)
+
+# Installation
+    Install a BDD (mysql is supported, SQLite maybe, PostgreSQL should be)
+    Makes sure that encoding is/will be in UNICODE/UTF-8
+    git clone http://dev.sigpipe.me/dashie/reel2bits
+    cd reel2bits
+    git submodule init
+    git submodule update
+    pip3 install --requirement requirements.txt  # if present
+    cp config.py.sample config.py
+    $EDITOR config.py
+    python3 reel2bits.py db upgrade
+    python3 reel2bits.py db seed
+    python3 reel2bits.py runserver # or whatever gunicorn whatever stuff
+    Don't forget to update default Config by getting to "Your user" (top right) then "Config"
+
+# Gunicorn
+    gunicorn -w 2 -b 127.0.0.1:8000 --error-logfile=errors.log --access-logfile=access.log --chdir=$PWD reel2bits:app
+
+# Default config
+ - App Name: My reel2bits instance
+
+# Crontabs and cache actions
+  List of cron target availables.
+  Makes sure to run them under the user which runs reel2bits and virtualenv if you use it.
+  Commands:
+  - none yet
+  
+# Crons explained
+  - none yet
+  
+# Licensing
+ - MIT License