X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=README.md;h=0fcd7f2fc2682cae5b1133e92a29cbabfec12a61;hb=6862a3a010c3299bb43fbccdd726d5cd08e695f3;hp=7f3c2d51834b174ed5dbaf4a7a4c9f888b6eab81;hpb=95b52115351db106a93613e6ea15f0e6acbeee42;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/README.md b/README.md index 7f3c2d51..0fcd7f2f 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,28 @@ rbot is a ruby IRC bot. Think of him as a ruby bot framework with a highly modular design based around plugins. -## Fork Changelog +## Install Guide +Information about installing the bot can be found here: [Install-Guide](https://github.com/4poc/rbot/wiki/Install-Guide). + +Notes on the registry and migrating from an old bot can be found here: [Registry-Migration-Notes](https://github.com/4poc/rbot/wiki/Registry-Migration-Notes). + +## Fork Changes + +- Ruby 2.1.1 is fully supported. - Drops ruby 1.8 support, ruby >= 1.9.3 is required. -- Ruby 2.1.0 is supported. - Removes a lot of broken/outdated plugins. - Removes the DRb remote interface due to its abysmal security. - Introduces a [web service](https://github.com/4poc/rbot/wiki/Web-Service). - Registry is now supporting DBM (that requires no external dependencies). +- [New standalone Backup/Restore Script](https://raw.github.com/4poc/rbot/fork/bin/rbotdb) for registry databases. +- Registry folders have now different names based on the adapter used: `~/.rbot/registry_` +- Added a bundler `Gemfile` to make installing the dependecies easier. ## Known Problems * Ruby 2.0.0 (at least <=p353) is causing a segmentation fault crash that -only occurs after a few hours. This is [fixed](https://bugs.ruby-lang.org/issues/9168) in newer versions. +only occurs after a few hours. This is [fixed](https://bugs.ruby-lang.org/issues/9168) in newer versions of ruby. -* DBM (if using Barkeley DB) is requiring manual repairs to work after +* DBM (if using Barkeley DB, maybe other backends aswell) is requiring manual repairs to work after a crash. -