From 088b1b35219b25e9233a6a9ece8aeb023a1e4c46 Mon Sep 17 00:00:00 2001 From: Ian Kronquist Date: Mon, 27 Jul 2015 17:01:27 -0700 Subject: [PATCH] (PDOC-33) Inform reader how to install yard gem The easiest cross platform way to install the yard gem is actually with puppet itself. We still need to cover the puppet 3.x vs 4.x cases though. --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index efc918d..afcac96 100644 --- a/README.md +++ b/README.md @@ -32,14 +32,24 @@ In order to run strings you need to have the following software installed: * Puppet 3.7 or newer * The yard rubygem -Install the yard rubygem with the gem command: +Installing the Yard Gem +----------------------- +**Installing the Yard Gem with Puppet** +The easiest way to install the Yard gem is with Puppet itself. + +For Puppet 4.x: ``` -$ gem install yard +$ puppet resource package yard provider=puppet_gem ``` -You may need to prefix this command with `bundle exec` or `sudo` depending on -your ruby environment. +For Puppet 3.x: +``` +$ puppet resource package yard provider=gem +``` + +Installing Strings Itself +------------------------- Strings can be installed from the [Puppet Forge][forge strings] or from source.