diff --git a/README.md b/README.md new file mode 100644 index 0000000..d73edac --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +pyircbot3 +========= +**A modular python IRC bot** + +Quick start +----------- + +* Install: `python3 setup.py install` +* Configure: `cd examples ; vim config.yml data/config/Services.yml` +* Run: `./run-example.sh` or `pyircbot -c config.yml` + +Developing Modules +------------------ + +Check docs/ + +TODO +---- + +* Fix docs/ +* Add a way to pass additional directories where modules are stored diff --git a/examples/config.instance.yml b/examples/config.yml similarity index 68% rename from examples/config.instance.yml rename to examples/config.yml index 9559ede..58bccc8 100644 --- a/examples/config.instance.yml +++ b/examples/config.yml @@ -1,5 +1,5 @@ bot: - datadir: /home/example/bot/data/ + datadir: ./data/ rpcbind: 0.0.0.0 rpcport: 1876 connection: @@ -9,5 +9,3 @@ connection: modules: - PingResponder - Services - - MySQL - - AttributeStorage \ No newline at end of file diff --git a/examples/run-example.sh b/examples/run-example.sh index 0dfd259..e9611ab 100755 --- a/examples/run-example.sh +++ b/examples/run-example.sh @@ -1,2 +1,2 @@ #!/bin/sh -../bin/pyircbot --config config.instance.yml +../bin/pyircbot --config config.yml