35 lines
736 B
Markdown
35 lines
736 B
Markdown
pyircbot3
|
||
=========
|
||
**A modular python IRC bot**
|
||
|
||
Quick start
|
||
-----------
|
||
|
||
* Install: `python3 setup.py install`
|
||
* 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
|
||
|
||
Or, use my pre-built copy [here](http://davepedu.com/files/botdocs/).
|
||
|
||
Alternatively, use the included Dockerfile to create an environment for
|
||
building the docs. Check `docs/builder/README.md`.
|
||
|
||
Developing Modules
|
||
------------------
|
||
|
||
Check *Module Developer’s Guide* in the docs
|
||
|
||
TODO
|
||
----
|
||
|
||
* Improve/complete docs
|
||
* Add a way to pass additional directories where modules are stored
|