From 5bc6486e3b1ccee5e4745bd6e72e732f14b6ac51 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Fri, 21 Jul 2017 22:13:32 +0200 Subject: [PATCH] Update docs --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bdf5b8381..a31b57d23 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,6 +60,19 @@ uploading it somewhere or post only the parts that are really relevant. Development Environment ======================= +In order to compile restic with the `go` tool directly, it needs to be checked +out at the right path within a `GOPATH`. The concept of a `GOPATH` is explained +in ["How to write Go code"](https://golang.org/doc/code.html). + +If you do not have a directory with Go code yet, executing the following +instructions in your shell will create one for you and check out the restic +repo: + + $ export GOPATH="$HOME/go" + $ mkdir -p "$GOPATH/src/github.com/restic" + $ cd "$GOPATH/src/github.com/restic" + $ git clone https://github.com/restic/restic + For development you need the build tool [`gb`](https://getgb.io), it can be installed by running the following command: