Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gmarcais committed Oct 5, 2015
1 parent 98b2f90 commit 475f38c
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,33 @@ line using getopt_long(3). See the Example section below for more details.

## Quick and easy

To install the yaggo script into your home directory, do:
Download the standalone script from the [release](https://github.com/gmarcais/yaggo/releases)
and copy it into a directory in your PATH (e.g. `~/bin`)

From the source tree, the same is achieved with:

```Shell
make DEST=$HOME/bin
```

## As a gem

To install using ruby's package manager gem, first generate the gem
Download the gem from the [release](https://github.com/gmarcais/yaggo/releases) and install it
with `sudo gem install ./yaggo-1.5.8.gem` (adjust the version!).

Similarly, from the source tree, first generate the gem
and then install it. For example here with version 1.5.3:

```Shell
rake gem
sudo gem install ./pkg/yaggo-1.5.3.gem
```

# Example
# Documentation

After installation, documentation is available with `yaggo --man`.

## Simple
# Simple example

Given the following configuration file 'parser.yaggo':

Expand Down

0 comments on commit 475f38c

Please sign in to comment.