kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

(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.
This commit is contained in:
Ian Kronquist 2015-07-27 17:01:27 -07:00
parent e9167b11e6
commit 088b1b3521
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -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.