From 9115a679d03d78b40ee86430a8db62646a79d9e2 Mon Sep 17 00:00:00 2001 From: Bernd Ahlers Date: Fri, 7 Apr 2017 17:37:23 +0200 Subject: [PATCH] Move the build instructions to the CONTRIBUTING file --- CONTRIBUTING.md | 8 ++++++++ README.md | 7 ------- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abc3933..e9b1e36 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,3 +21,11 @@ Found a bug? Have an idea for an improvement? Feel free to [add an issue](../../ Before we can accept any code from you, we need you to sign our Contributor License Agreement. If you create a pull request, a cla-assistant bot will ask you to sign the CLA. + +## Building the project + +- Install [golang](https://golang.org/dl/) for your operating system +- Setup the `PATH` and `GOROOT` so the go binary is available +- Run `make build` +- Run `make install` to install it into `$HOME/bin` + diff --git a/README.md b/README.md index 560332b..bb2d47b 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,6 @@ CLI tool for [graylog-project](https://github.com/Graylog2/graylog-project). * Copy the downloaded binary to a directory in your `PATH` (i.e. `cp graylog-project.linux $HOME/bin/graylog-project` * See [graylog-project instructions](https://github.com/Graylog2/graylog-project/blob/master/README.md) on how to use it -## Build - -- Install [golang](https://golang.org/dl/) for your operating system -- Setup the `PATH` and `GOROOT` so the go binary is available -- Run `make build` -- Run `make install` to install it into `$HOME/bin` - ## Contributing Please read [the contributing instructions](CONTRIBUTING.md) to get started.