From df7ff87f91307d6292269a4e9f327330fa4cfb79 Mon Sep 17 00:00:00 2001 From: Andrea Sessa Date: Wed, 30 May 2018 15:59:05 +0200 Subject: [PATCH] Updated readme with build instructions --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0c034e3..ec39b8f 100644 --- a/README.md +++ b/README.md @@ -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 [] @@ -22,7 +55,7 @@ Flags: --version Show application version. ``` -## PromPLAY +### PromPLAY ``` usage: promplay []