From 05500dc5f818f9082cce74ea002cb1d712eaef24 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Sun, 23 Jul 2017 14:32:31 +0200 Subject: [PATCH] Update documentation --- CONTRIBUTING.md | 50 +++++++++++-------------------------------------- 1 file changed, 11 insertions(+), 39 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a31b57d23..74699a125 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,51 +72,23 @@ repo: $ 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: - - $ go get github.com/constabulary/gb/... - -The repository contains two directories with code: `src/` contains the code -written for restic, whereas `vendor/` contains copies of libraries restic -depends on. The libraries are managed with the `gb vendor` command. - -Just clone the repository, `cd` to it and run `gb build` to build the binary: - - $ git clone https://github.com/restic/restic $ cd restic - $ gb build - [...] - $ bin/restic version + +You can then build restic as follows: + + $ go build ./cmd/restic + $ ./restic version restic compiled manually - compiled at unknown time with go1.7 + compiled with go1.8.3 on linux/amd64 The following commands can be used to run all the tests: - $ gb test - ok github.com/restic/restic 8.174s - [...] + $ go test ./cmd/... ./internal/... -If you want to run your tests on Linux, OpenBSD or FreeBSD, you can use -[vagrant](https://www.vagrantup.com/) with the provided `Vagrantfile` to -quickly set up VMs and run the tests, e.g.: - - $ vagrant up freebsd - [...] - - $ vagrant ssh freebsd -c 'cd restic/restic; go test -v ./...' - [...] - -The default `go` tool can also be used by setting the environment variable -`GOPATH` to the following value while being in the top level directory in the -git repository: - - $ export GOPATH=$PWD:$PWD/vendor - -The file `.envrc` allows automatic `GOPATH` configuration with -[direnv](https://direnv.net/), inspect the file and then allow automatic -configuration by running `direnv allow`. +The repository contains two sets of directories with code: `cmd/` and +`internal/` contain the code written for restic, whereas `vendor/` contains +copies of libraries restic depends on. The libraries are managed with the +[`dep`](https://github.com/golang/dep) tool. Providing Patches =================