Anonymous avatar Anonymous committed 7349b57

Add some blurb.

Comments (0)

Files changed (1)

-This package is a python module to interface with Ditz, a distributed issue
-tracker.  To build it:
+.. README for PyDitz, in -*- rst -*- mode.
+
+========
+ PyDitz
+========
+
+This package is a python module to interface with issues produced by the
+Ditz distributed issue tracker (http://ditz.rubyforge.org).
+
+If you're interested in other Pythonic ways to to Ditzy things, you may
+also want to check out Pitz (http://pitz.tplus1.com).
+
+Requirements
+============
+
+You'll need PyYAML (http://pyyaml.org).
+
+Installation
+============
+
+To build it::
 
     python setup.py build
 
-To install it:
+To install it::
 
     python setup.py install
 
-Type
+Type::
 
     python setup.py --help
 
 for other things you can do.
 
-Note: if you're on a Linux box you can just type 'make' and 'make install'
-in the usual manner.
+Note: if you're on a Linux box you can just type ``make`` and ``make
+install`` in the usual manner.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.