aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCyril Roelandt <tipecaml@gmail.com>2018-12-08 22:42:16 +0100
committerCyril Roelandt <tipecaml@gmail.com>2018-12-08 22:42:16 +0100
commitc31e7fbab5569206410e344af68ec3d01132050f (patch)
treea77e325d34c613c9ee42707351398efac11fff31
parent2ac2c8812ff343d2c4cade00d6ea17339d329fa8 (diff)
downloadgit-bug-c31e7fbab5569206410e344af68ec3d01132050f.tar.gz
README.md: Add developer-specific information.
Cloning a Go project is a weird thing for developers unfamiliar with the language. This closes #77.
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index a4e1c227..ccc89f62 100644
--- a/README.md
+++ b/README.md
@@ -118,6 +118,20 @@ Interested by how it works ? Have a look at the [data model](doc/model.md).
## Contribute
+Developers unfamiliar with Go may try to clone the repository using "git clone".
+Instead, one should use:
+
+```shell
+go get -u github.com/MichaelMure/git-bug
+```
+
+The git repository will then be available:
+
+```shell
+# Note that $GOPATH defaults to $HOME/go
+$ cd $GOPATH/src/github.com/MichaelMure/git-bug/
+```
+
PRs accepted. Drop by the [Gitter lobby](https://gitter.im/the-git-bug/Lobby) for a chat.
## Contributors