aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index a4e1c227..327fbd85 100644
--- a/README.md
+++ b/README.md
@@ -118,7 +118,25 @@ Interested by how it works ? Have a look at the [data model](doc/model.md).
## Contribute
-PRs accepted. Drop by the [Gitter lobby](https://gitter.im/the-git-bug/Lobby) for a chat.
+PRs accepted. Drop by the [Gitter lobby](https://gitter.im/the-git-bug/Lobby) for a chat or browse the issues to see what is worked on or discussed.
+
+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/
+```
+
+You can now run `make` to build the project, or `make install` to install the binary in `$GOPATH/bin/`.
+
+To work on the web UI, have a look at [the dedicated Readme.](webui/Readme.md)
+
## Contributors