aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar jesopo2019-12-06 17:09:22 +0000
committerGravatar jesopo2019-12-06 17:09:55 +0000
commit99341fcc3b0f2f196bcbce13b56f313a5f65e415 (patch)
tree9fa2f2884d554894e9782026b0ef5e9e4157362d /README.md
parentremove database_backup.py, add note in README.md about what should be backed up (diff)
signature
make "Setup" a whole category of README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 05ecbb73..09a119e5 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,15 @@
# BitBot
Python3 event-driven modular IRC bot!
-## Requirements
+## Setup
+
+### Requirements
`$ pip3 install --user -r requirements.txt`
-## Setup
-See [docs/help/setup.md](docs/help/setup.md).
+### Config
+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.
## Github, Gitea and GitLab web hooks