Permalink
Browse files

Replace the doxygen README (which was broken) with a restructued text

based README.
  • Loading branch information...
1 parent 5df1262 commit 3bcb80e9a06a4b44a8aa1406ef3ab1beb6f856c8 @clemesha-ooi clemesha-ooi committed Nov 16, 2009
Showing with 61 additions and 59 deletions.
  1. +0 −59 README.py
  2. +61 −0 README.rst
View
59 README.py
@@ -1,59 +0,0 @@
-#!/usr/bin/env python
-
-"""
-@file README.py
-@author Alex Clemesha <clemesha@ucsd.edu>
-@date 8/18/09
-
-@mainpage
-txrabbitmq - RabbitMQ's `rabbitmqctl` as a Twisted Service.
-
-
-@section Overview
-
-Implements RabbitMQ's `rabbitmqctl` command line tool as a Twisted Service,
-Expose this functionality over several protocols, most importantly: HTTP and AMQP.
-
-
-@section Install
-
-Get the latest code:
-@code
- $ git clone git@amoeba.ucsd.edu:txrabbitmq.git
-@endcode
-
-The recommend way of using `txrabbitmq` is to create a `virtualenv` and
-the install all dependencies with `pip` into the `virtualenv`
-@code
- $ virtualenv --no-site-packages txrabbitmq_env
- $ pip -E txrabbitmq_env install -U twotp orbited twisted simplejson stompservice
-@endcode
-
-
-@section Usage
-
-@subsection usage Start up the RESTful Command/Data http service:
-
-From top-level package directory run:
-@code
- $ twistd -n txrabbitmq
-@endcode
-
-
-@subsection usage Get realtime data from RabbitMQ:
-
-From top-level package directory run:
-@code
- $ twistd -n txrabbitmq
-@endcode
-
-Open 2nd shell, navigate to the directory `webui/push` and run:
-@code
- $ python data_producer.py #first shell
- $ orbited --config=rabbitmq.cfg #second shell
-@endcode
-
-Open ports 8000 and 9000, to see commands data and push, respectively
-"""
-
-print "This README's format is a massive Doxygen @mainpage hack. FIXME!!!"
View
61 README.rst
@@ -0,0 +1,61 @@
+txrabbitmq - RabbitMQ's `rabbitmqctl` as a Twisted Service.
+===========================================================
+
+
+Overview
+--------
+
+Implements RabbitMQ's `rabbitmqctl` command line tool as a Twisted Service,
+Expose this functionality over several protocols, most importantly: HTTP and AMQP.
+
+
+Install
+-------
+
+Get the latest code::
+
+ $ git://github.com/clemesha-ooi/txrabbitmq.git
+
+
+The recommend way of using `txrabbitmq` is to create a `virtualenv` and
+the install all dependencies with `pip` into the `virtualenv`::
+
+ $ virtualenv --no-site-packages txrabbitmq_env
+ $ pip -E txrabbitmq_env install -U twotp orbited twisted simplejson stompservice
+
+
+Usage
+-----
+
+Start up the RESTful Command/Data http service:
+
+From top-level package directory run::
+
+ $ twistd -n txrabbitmq
+
+
+Get realtime data from RabbitMQ:
+
+From top-level package directory run::
+
+ $ twistd -n txrabbitmq
+
+Open 2nd shell, navigate to the directory `webui/push` and run::
+
+ $ python data_producer.py #first shell
+ $ orbited --config=rabbitmq.cfg #second shell
+
+Open ports 8000 and 9000, to see commands data and push, respectively
+
+
+License
+-------
+Apache License:
+http://www.opensource.org/licenses/apache2.0.php
+
+
+Contact
+-------
+This code is part of the Ocean Observatories Initiative project,
+for more details please see here: http://ci.oceanobservatories.org/
+Or email the author: Alex Clemesha <clemesha@ucsd.edu>.

0 comments on commit 3bcb80e

Please sign in to comment.