X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/76dfe9af1549462b3a1225736f2875d5253105d5..b376c8253cf227f11e50157fd10c02b1cd784646:/README.md diff --git a/README.md b/README.md index 6a7fbdb..39ab04c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -Modular {Python2,Python3} IRC bot -================================= +Modular Python{2,3} IRC bot +=========================== -Getting started: +Getting started +--------------- - `cp bot.config.example bot.config` - `vim bot.config` - Create a MySQL database, i.e. `CREATE DATABASE foo; GRANT ALL ON foo.* TO ...` @@ -12,14 +13,14 @@ Install croncheck.sh in your crontab, if desired. `* * * * * /path/to/erebus/croncheck.sh` To suppress croncheck.sh from restarting the bot without removing from crontab, `touch dontstart` -Output will be placed in `logfile`, which is rotated to `oldlogs/`. (I strongly recommend `rm oldlogs/*` as a weekly crontab entry.) +Output will be placed in `logfile`, which is rotated to `oldlogs/`. (I strongly recommend `rm oldlogs/*` as a weekly crontab entry. `@weekly find /path/to/erebus/oldlogs/ -mtime 7 -execdir rm '{}' +`) The bot targets both Python 2 and 3. However, it is generally only actively tested on Python 2. If it's not working on Python 3 (or an included module isn't working on Python 3), please raise a bug. Some modules require additional supporting materials, which can be found in `modules/contrib/`. -***** + Module API ---------- The module API has largely remained backwards-compatible and likely will remain so into the future. However, it is still currently unstable, primarily because it's only tested with the included modules. If you find a change was introduced which breaks something you relied on, please raise a bug.