Skip to content

Commit 01fd718

Browse files
committed
Add notes on ruby 3 incompatibility
1 parent ec32741 commit 01fd718

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ The channel bot in [#easyrpg][webchat] on Libera Chat, provides logs, pizza and
44
a lot of other stuff.
55

66
It is is written in ruby, using the [cinch][cinch] bot framework (our legacy
7-
[EV0001][ev0001] bot was written from scratch).
7+
[EV0001][ev0001] bot was written from scratch). It runs with older rubies, is
8+
not compatible with the current version `ruby 3`.
89

910
## Installation
1011

@@ -26,6 +27,8 @@ You can use bundler to install them and their dependencies.
2627
$ bundle config set --local clean true
2728
$ bundle install
2829

30+
For Arch Linux replace `bundle` with `bundle2.7`.
31+
2932
Secret values (passwords and such) are read from a file `secrets.yml` on startup.
3033
A template is provided, you need to copy it and fill in the values or remove all
3134
references to `$secrets` and fill in the values directly.
@@ -37,6 +40,10 @@ references to `$secrets` and fill in the values directly.
3740
This helper script tries to detect if you installed the gems locally with bundler and
3841
will run EV0002 in bundler environment if needed.
3942

43+
If your system is recent, it will ship with a newer version of ruby, we recommend
44+
using [rvm][rvm] or [rbenv][rbenv] to install and use ruby 2.7.6 for the time being,
45+
a `.ruby-version` file is provided.
46+
4047
## LICENSE
4148

4249
This bot and plugins were written by carstene1ns and the EV0002 authors.
@@ -130,4 +137,6 @@ https://github.com/Quintus/cinch-plugins
130137
[googleauth]: https://github.com/google/google-auth-library-ruby
131138
[jenkins2-api]: https://github.com/yitsushi/jenkins2-api
132139
[xmlrpc]: https://github.com/ruby/xmlrpc
140+
[rvm]: https://rvm.io
141+
[rbenv]: https://github.com/rbenv/rbenv
133142
[quintus]: https://github.com/Quintus

0 commit comments

Comments
 (0)