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

make "Setup" a whole category of README.md

Browse source
This commit is contained in:
jesopo 2019-12-06 17:09:22 +00:00
parent 9664e275f4
commit 99341fcc3b
2 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,13 +1,15 @@
# BitBot # BitBot
Python3 event-driven modular IRC bot! Python3 event-driven modular IRC bot!
## Requirements ## Setup
### Requirements
`$ pip3 install --user -r requirements.txt` `$ pip3 install --user -r requirements.txt`
## Setup ### Config
See [docs/help/setup.md](docs/help/setup.md). See [docs/help/config.md](docs/help/config.md).
## Backups ### 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. 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.
## Github, Gitea and GitLab web hooks ## Github, Gitea and GitLab web hooks

0
docs/help/setup.md → docs/help/config.md
View file