Update readme

This commit is contained in:
dpedu 2015-06-18 23:03:15 -07:00
parent a75dbef233
commit a14dcaa387

View File

@ -9,13 +9,20 @@ Quick start
* Configure: `cd examples ; vim config.json data/config/Services.json`
* Run: `pyircbot -c config.json`
Building Docs
------------
* Install sphinx and all modules pyircbot depends on
* `cd docs ; make html`
* Open _build/index.html
Developing Modules
------------------
Check docs/
Check *Module Developers Guide* in the docs
TODO
----
* Fix docs/
* Update docs
* Add a way to pass additional directories where modules are stored