rendering docs for tests and installation. More to come

Author: yashh

.gitignore

@@ -0,0 +1 @@
+*.pyc

_sources/class.txt

@@ -0,0 +1,6 @@
+.. module:: pyres
+
+ResQ Classes
+==========================================
+
+.. autoclass:: pyres.ResQ

_sources/example.txt

@@ -42,6 +42,6 @@ In the **scripts** folder there is an executable::
     $ ./pyres_worker Spam
 
 
-Just pass a comma seperated list of queues the worker should poll.
+Just pass a comma separated list of queues the worker should poll.
 
 

_sources/index.txt

@@ -12,6 +12,10 @@ Contents:
    :maxdepth: 2
 
    intro
+   install
+   example
+   class
+   tests
 
 Indices and tables
 ==================

_sources/install.txt

@@ -0,0 +1,26 @@
+Installation
+===============
+
+Requirements:
+--------------
+simplejson>=2.0.9  
+itty>=0.6.2   
+redis>=0.6.0   
+pystache>=0.1.0  
+
+Make sure you install these requirements before proceeding. 
+
+.. todo:: Need to point to notes on redis installation and get python-redis.
+
+
+To install pyres.::
+
+    $ git clone git://github.com/binarydud/pyres.git
+    $ cd pyres
+    $ python setup.py build
+    $ python setup.py install
+
+Might need to run as sudo to install.
+
+
+

_sources/tests.txt

@@ -0,0 +1,15 @@
+Tests
+=======
+
+PyRes comes with a test suite which connects to a local redis server and 
+creates a couple of *Queues* and *jobs*. 
+
+To run tests make sure you have nose_ installed.::
+
+    $ easy_install nose
+    $ redis-server [PATH_TO_YOUR_REDIS_CONFIG]
+    $ nosetests
+
+Add **-v** flag if you want verbose output.
+
+.. _nose: http://somethingaboutorange.com/mrl/projects/nose/0.11.1/