From c31e7fbab5569206410e344af68ec3d01132050f Mon Sep 17 00:00:00 2001 From: Cyril Roelandt Date: Sat, 8 Dec 2018 22:42:16 +0100 Subject: README.md: Add developer-specific information. Cloning a Go project is a weird thing for developers unfamiliar with the language. This closes #77. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README.md') 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 -- cgit