From 46c38f0bed57d1f4940ce3871507b482068f6af6 Mon Sep 17 00:00:00 2001 From: marengaz Date: Wed, 27 Jan 2021 13:32:38 +0000 Subject: [PATCH] ruby3 not supported. instructions for mac (#782) --- docs/documenting.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/documenting.md b/docs/documenting.md index d943cda5..d401bad4 100644 --- a/docs/documenting.md +++ b/docs/documenting.md @@ -14,11 +14,12 @@ For larger changes, we suggest that you clone the website repository. This way, To test your changes locally, you need to install **Ruby** and its dependencies (gems): -- [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/) if you don't have it already. Ruby version 2.5.0 or higher is required. +- [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/) if you don't have it already. Ruby version 2.5.0 or higher is required. Ruby version 3 is not supported yet. - Install `bundler`, a dependency manager for Ruby: `$ gem install bundler` (You might have to run this command as `sudo`). - Shortcut for Fedora: `$ sudo dnf -y install gcc-c++ ruby ruby-devel rubygem-bundler rubygem-json && bundle` - Shortcut for Debian/Ubuntu: `$ sudo apt-get install ruby ruby-dev ruby-bundler ruby-json g++ zlib1g-dev && bundle` +- Shortcut for Mac (if the bundled Ruby doesn't work): `brew install ruby@2.7 && export PATH="/usr/local/opt/ruby@2.7/bin:$PATH"` - Fork the home-assistant.io [git repository](https://github.com/home-assistant/home-assistant.io). - In your home-assistant.io root directory, run `$ bundle` to install the gems you need.