2015-06-18 20:06:28 -07:00
pyircbot3
=========
**A modular python IRC bot**
Quick start
-----------
* Install: `python3 setup.py install`
2015-06-18 22:30:29 -07:00
* Configure: `cd examples ; vim config.json data/config/Services.json`
* Run: `pyircbot -c config.json`
2015-06-18 20:06:28 -07:00
2015-12-13 14:17:15 -08:00
Running in docker
-----------------
A dockerfile is included at `examples/docker/` . From the *root* of this repository, run `docker build -t pyircbot -f examples/docker/Dockerfile .` to build it. Typical use is mounting a directory from the host onto `/srv/bot` ; this dir should contain config.json and any other dirs it references.
2015-06-19 17:49:53 -07:00
2015-06-18 23:03:15 -07:00
Building Docs
2015-06-19 17:49:53 -07:00
-------------
2015-06-18 23:03:15 -07:00
* Install sphinx and all modules pyircbot depends on
* `cd docs ; make html`
* Open _build/index.html
2015-06-19 20:56:21 -07:00
Or, use my pre-built copy [here ](http://davepedu.com/files/botdocs/ ).
2015-06-19 21:09:43 -07:00
Alternatively, use the included Dockerfile to create an environment for
building the docs. Check `docs/builder/README.md` .
2015-06-18 20:06:28 -07:00
Developing Modules
------------------
2015-06-18 23:03:15 -07:00
Check *Module Developer’ s Guide* in the docs
2015-06-18 20:06:28 -07:00
TODO
----
2015-06-19 20:56:21 -07:00
* Improve/complete docs
2015-08-30 22:15:41 -07:00
* Write config checker