From 99341fcc3b0f2f196bcbce13b56f313a5f65e415 Mon Sep 17 00:00:00 2001 From: jesopo Date: Fri, 6 Dec 2019 17:09:22 +0000 Subject: make "Setup" a whole category of README.md --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'README.md') 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 -- cgit v1.3.1-10-gc9f91