Skip to content

Commit

Permalink
Merge pull request #4 from Sessa93/master
Browse files Browse the repository at this point in the history
Updated readme with build instructions
  • Loading branch information
parry84 authored May 30, 2018
2 parents 7f9e5dc + df7ff87 commit 880d284
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,40 @@
- `promrec` tapes the metrics in a specified output file.
- `promplay` backfills the _prometheus_ database from scratch.

## PromREC
## Build instructions (Linux/OSX)

Clone this repository in your **$GOPATH**:

```
$ mkdir -p $GOPATH/src/github.com/Cleafy
$ cd $GOPATH/src/github.com/Cleafy
$ git clone https://github.com/Cleafy/promqueen.git
```

Use Go package manager ***dep*** to install the required dependencies:

```
$ cd $GOPATH/src/github.com/Cleafy/promqueen
$ dep ensure
```

To build `promrec`:

```
$ cd $GOPATH/src/github.com/Cleafy/promqueen/bin/promrec
$ go build
```

To build `promplay`:

```
$ cd $GOPATH/src/github.com/Cleafy/promqueen/bin/promplay
$ go build
```

## Usage

### PromREC

```
usage: promrec [<flags>]
Expand All @@ -22,7 +55,7 @@ Flags:
--version Show application version.
```

## PromPLAY
### PromPLAY

```
usage: promplay [<flags>]
Expand Down

0 comments on commit 880d284

Please sign in to comment.