From c416eb510d5f9aa47005bbff6e2f926c8b71f81b Mon Sep 17 00:00:00 2001 From: Kudakwashe Paradzayi Date: Fri, 25 May 2018 02:21:53 -0700 Subject: [PATCH] Add an extra prerequisite - ruby2.x-dev in docs/README.md (#1820) * Add an extra prerequisite - ruby2.x-dev Trying to install Jekyll on my Linux (Ubuntu 16.04) machine failed because ```ruby 2.x``` was installed and ```ruby2.x-dev``` was not. I spent a lot of time trying to figure it out (I'm no ruby expert) but installing the ```ruby2.x-dev``` solved my problem. * Add a note for Ubuntu users --- docs/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/README.md b/docs/README.md index ba661bb3..ca1567ff 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,6 +5,8 @@ The documentation HTML is produced with the Ruby-based `jekyll` tool. 1. Make sure Ruby 2.x is installed. 2. `gem install jekyll` +> **Note**: If you are an ```Ubuntu user``` Make sure ruby2.x-dev is installed + ## Viewing the documentation locally Then to view the documentation in your local checkout: