Skip to content

Commit

Permalink
Re-write the "Running it" section with pointers to documentation; pre…
Browse files Browse the repository at this point in the history
…viously, it looked like an example, which led to sadness.
  • Loading branch information
Chris Doherty committed May 3, 2013
1 parent 819ac85 commit ba5279a
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Expand Up @@ -68,9 +68,17 @@ You can install fpm with gem:

gem install fpm

Running it:
Building a package named "awesome" might look something like this:

fpm -n awesome -t <output package type> -s <source type> [list of sources]...

You have two options for learning to run FPM:

1. If you're impatient, just scan through `fpm --help`; you'll need various options, and
they're reasonably straightforward. Note that with the `-s` option, for source type `dir`,
the `-s dir <list of directories>` must be the final argument.
1. [The wiki](https://github.com/jordansissel/fpm/wiki) has explanations and examples.

fpm -s TYPE -t TYPE ...

## Things that are in the works or should work:

Expand Down

0 comments on commit ba5279a

Please sign in to comment.