Firepup650/bitbot-3.11-fork
2
0
Fork 0
Code Issues Pull requests Activity Actions

Combine ## Running with ## Configurating in README.md

Browse source
This commit is contained in:
jesopo 2019-01-19 17:08:18 +00:00
parent 3b263aab2c
commit 88407b2055
1 changed files with 2 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -14,16 +14,13 @@ Use `pip3 install -r requirements.txt` to install them all at once.
## Configurating ## 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.) 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.)
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`.
## Github web hooks ## Github web hooks
I run BitBot as-a-serivce on most popular network and offer github-to-IRC web hook notifications for free to FOSS projects. Contact me for more information! I run BitBot as-a-serivce on most popular network and offer github-to-IRC web hook notifications for free to FOSS projects. Contact me for more information!
## Eagle ## Eagle
BitBot's National Rail module can optionally include output from Network Rail's SCHEDULE via [Eagle](https://github.com/EvelynSubarrow/Eagle). Configuration on BitBot's end is covered by the `eagle-` keys in bot.conf.example. BitBot's National Rail module can optionally include output from Network Rail's SCHEDULE via [Eagle](https://github.com/EvelynSubarrow/Eagle). Configuration on BitBot's end is covered by the `eagle-` keys in bot.conf.example.
## Running
Just run `./start.py`
On first boot, he'll ask for a first server to connect to then exit. do `./start.py` again and he'll connect to that server and join #bitbot (to get him to join other channels, simply invite him to them.)
## Contact/Support ## Contact/Support
Come say hi at [##bitbot on freenode](https://webchat.freenode.net/?channels=##bitbot) Come say hi at [##bitbot on freenode](https://webchat.freenode.net/?channels=##bitbot)