From f5ca88fe0af47a8cb7cff20ce2d117e3fc716e4d Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Sun, 29 Jul 2012 15:36:00 +1200 Subject: README --- README.mkd | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.mkd b/README.mkd index 6feb5c3c..d3643e73 100644 --- a/README.mkd +++ b/README.mkd @@ -5,6 +5,14 @@ clients and servers. The project has three components: - __pathoc__, a perverse HTTP client. - __libpathod.test__, an API for easily using __pathod__ and __pathoc__ in unit tests. +The pathod documentation is self-hosted. Just fire up pathod, like so: + + ./pathod + +And then browse to: + + http://localhost:9999 + # Installing @@ -13,6 +21,10 @@ dependencies is dead simple: pip install pathod -The project uses the __nose__ unit testing framework, which you can get here: +The project has the following dependencies: + +* [netlib](http://github.com/cortesi/netlib) +* [requests](http://docs.python-requests.org/en/latest/index.html) - FIXME +The project's test suite uses the +[nose](http://nose.readthedocs.org/en/latest/) unit testing framework. -- cgit v1.2.3