bitbot-3.11-fork/README.md

23 lines
934 B
Markdown
Raw Normal View History

2016-03-29 11:56:58 +00:00
# BitBot
Python3 event-driven modular IRC bot!
## Setup
### Requirements
`$ pip3 install --user -r requirements.txt`
2016-03-29 11:56:58 +00:00
### Config
See [docs/help/config.md](docs/help/config.md).
2016-03-29 11:56:58 +00:00
### Backups
If you wish to create backups of your BitBot instance (which you should, [borgbackup](https://borgbackup.readthedocs.io/en/stable/) is a good option), I advise backing up the entirety of `~/.bitbot` - where BitBot by-default keeps config files, database files and rotated log files.
2019-10-18 12:22:25 +00:00
## Github, Gitea and GitLab web hooks
I run BitBot as-a-service on most popular networks (willing to add more networks!) and offer github/gitea/gitlab webhook to IRC notifications for free to FOSS projects. Contact me for more information!
## Contact/Support
2019-02-18 16:30:11 +00:00
Come say hi at [#bitbot on freenode](https://webchat.freenode.net/?channels=#bitbot)
## License
2019-09-25 17:34:04 +00:00
This project is licensed under GNU General Public License v2.0 - see [LICENSE](LICENSE) for details.