]> git.zarvox.org Git - imoo.git/commitdiff
Update README. ribbon_passthrough serves its own assets.
authorDrew Fisher <drew.m.fisher@gmail.com>
Thu, 8 May 2014 02:33:18 +0000 (19:33 -0700)
committerDrew Fisher <drew.m.fisher@gmail.com>
Thu, 8 May 2014 02:33:18 +0000 (19:33 -0700)
README.md
reactornado/ribbon_passthrough.py

index e56155d7d4a7bef2e4195329299165ac5ae7d503..6e0fec4d38e6a50be33dd9883a260af53bd72f56 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,49 @@
 imoo
+====
 
-A cow-erful web frontend to bitlbee.
+A web-based chat gateway.
 
-SETUP
+Dependencies:
+  - libpurple (tested against 2.10.9)
+  - qt5
+  - python
+  - Linux (We currently rely on the Qt-glib eventloop integration, which only exists on Linux.)
+  - A modern web browser
+
+Setup
+-----
+
+Build ribbon, the network-socket-to-libpurple adapter:
+
+```bash
+cd ribbon
+qmake-qt5 ribbon.pro
+make
+cd ../
+```
+
+Prepare a virtualenv:
+
+```bash
+virtualenv env
+env/bin/pip install tornado
+```
+
+Run the server:
+
+```bash
+cd reactornado
+../env/bin/python ribbon_passthrough.py
+```
+
+Then, point your browser at http://localhost:8889
+
+--------------------------------------------------
+
+Some other stuff for server-side persistence (backburnered for now)
 
 ```bash
 virtualenv env
-env/bin/pip install Flask Flask-Login Flask-SQLAlchemy Flask-WTF Flask-Scrypt Flask-RESTful sqlalchemy-migrate
+env/bin/pip install Flask Flask-Login Flask-SQLAlchemy Flask-WTF Flask-Scrypt Flask-RESTful sqlalchemy-migrate tornado
 ./run.py
 ```
index 8d3c11079010d07730d57c490f513fa78bb95170..3a24aaa5e80b925a165c37d34245a76a331c2acd 100644 (file)
@@ -72,6 +72,9 @@ class WSHandler(tornado.websocket.WebSocketHandler):
 
 
 application = tornado.web.Application([
+    (r'/(index.html)', tornado.web.StaticFileHandler, {'path': pwd}),
+    (r'/([a-z]*\.js)', tornado.web.StaticFileHandler, {'path': pwd}),
+    (r'/([a-z]*\.css)', tornado.web.StaticFileHandler, {'path': pwd}),
     (r'/ws', WSHandler),
 ])