Permalink
Browse files

Adding README.rst files to the example dirs so it looks pretty in git…

…hub. Linking to Python examples from the using doc.
  • Loading branch information...
1 parent 844b9e1 commit d34042a76bac5f1ebccde88b0befda02deb080f3 Greg Taylor committed Apr 18, 2012
Showing with 37 additions and 5 deletions.
  1. +7 −5 doc_src/using.rst
  2. +22 −0 examples/README.rst
  3. +8 −0 examples/python/README.rst
View
@@ -36,14 +36,15 @@ Python
^^^^^^
The following example uses the pyzmq_ module (available off of PyPi)
-and simplejson_. You can substitute the stdlib's json_ module, if that suits
-your fancy::
+and simplejson_. For a more complete list of examples, see the
+`Python examples`_ dir on github.::
- #
- # Example Python EMDR client.
- #
+ """
+ Example Python EMDR client.
+ """
import zlib
import zmq
+ # You can substitute the stdlib's json module, if that suits your fancy
import simplejson
def main():
@@ -70,6 +71,7 @@ your fancy::
.. _pyzmq: http://pypi.python.org/pypi/pyzmq/
.. _simplejson: http://pypi.python.org/pypi/simplejson/
.. _json: http://docs.python.org/library/json.html
+.. _Python examples: https://github.com/gtaylor/EVE-Market-Data-Relay/tree/master/examples/python
PHP
^^^
View
@@ -0,0 +1,22 @@
+EMDR Code Examples
+==================
+
+The sub-directories contained within ``examples`` contain code examples for
+various languages. There is no particular rhyme or reason to the contents
+of these, and all submissions are welcome.
+
+If you write something cool, post to the issue tracker or submit a pull
+request and we'll get it added in here.
+
+Disclaimer
+----------
+
+The code contained within is not guaranteed work, and it very well may
+eat your lunch. We will do our best to filter out bad code, but will largely
+rely on your help in policing the contents.
+
+License
+-------
+
+All code submitted here is licensed under the BSD License, unless otherwise
+specified by the author.
@@ -0,0 +1,8 @@
+Python Examples
+===============
+
+This directory contains EMDR examples written in Python.
+
+:greenlet_consumer: An example consumer written using greenlets. This consumer
+ can handle a very large number of messages per second, and closely resembles
+ EMDR's processor daemons.

0 comments on commit d34042a

Please sign in to comment.