aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar jesopo2019-04-15 16:59:27 +0100
committerGravatar jesopo2019-04-15 16:59:27 +0100
commitd14eaa31488f440bfc41d1422bb3c27492485184 (patch)
tree321cb61315c7ab71e88734a873f3d70fb4e299d5 /README.md
parentAllow adding perform.py commands through chat and add !performexecute, to (diff)
signature
Add first version of docs/help/setup.md and link to it in README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index a63fafa7..5bc994e7 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,8 @@ Python3 event-driven modular IRC bot!
## Dependencies
[BeautifulSoup4](https://pypi.python.org/pypi/beautifulsoup4), [requests](https://pypi.org/project/requests/), [scrypt](https://pypi.python.org/pypi/scrypt), [suds](https://pypi.python.org/pypi/suds-jurko) and [twitter](https://pypi.python.org/pypi/twitter). Use `pip3 install -r requirements.txt` to install them all at once.
-## Configurating
-To get BitBot off the ground, there's some API-keys and the like in bot.conf.example. move it to bot.conf, fill in the API keys you want (and remove the ones you don't want - this will automatically disable the modules that rely on them.)
+## Setup
+See [docs/help/setup.md](docs/help/setup.md).
Run `./start.py` to run the bot with default settings (`--help` for more information) which will ask you for server details the first time you run it (run it again after filling out that information to get the bot going.) If you need to add more servers, use `./start.py --add-server`.