Skip to content

Commit

Permalink
Merge pull request #220 from Miroshni4enko/master
Browse files Browse the repository at this point in the history
Make installation block more usable
  • Loading branch information
jonabc authored Nov 6, 2019
2 parents 7bebc0a + 923cfa8 commit 370ab4d
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@ See the [migration documentation](./docs/migrating_to_newer_versions.md) for mor

## Installation

### Dependencies

Licensed uses the `libgit2` bindings for Ruby provided by `rugged`. `rugged` requires `cmake` and `pkg-config` which you may need to install before you can install Licensed.

> Ubuntu
sudo apt-get install cmake pkg-config

> OS X
brew install cmake pkg-config

### With a Gemfile

Add this line to your application's Gemfile:
Expand Down Expand Up @@ -48,12 +60,6 @@ $ ./licensed list

For system wide usage, install licensed to a location on `$PATH`, e.g. `/usr/local/bin`.

#### Dependencies

Licensed uses the `libgit2` bindings for Ruby provided by `rugged`. `rugged` has its own dependencies - `cmake` and `pkg-config` - which you may need to install before you can install Licensed.

For example, on macOS with Homebrew: `brew install cmake pkg-config` and on Ubuntu: `apt-get install cmake pkg-config`.

## Usage

- `licensed list`: Output enumerated dependencies only.
Expand Down

0 comments on commit 370ab4d

Please sign in to comment.