git » chasquid » commit e8511e3

docs: Update install/build documentation

author Alberto Bertogli
2019-10-25 14:57:03 UTC
committer Alberto Bertogli
2019-10-25 15:00:15 UTC
parent a47faf89a48eacc1c1942b99f120606cc02113ba

docs: Update install/build documentation

This patch updates the installation guide to try to make the
installation section more readable.

It also assumes a modern Go environment is installed, which
simplifies the process of building from source.

docs/install.md +12 -5

diff --git a/docs/install.md b/docs/install.md
index 5e088a9..9198ae7 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -3,16 +3,23 @@
 
 ## Installation
 
-If you're using Debian or Ubuntu, chasquid can be installed by running
-`sudo apt install chasquid`.
+### Debian/Ubuntu
 
-To get, build and install the source, you will need a working
+If you're using Debian or Ubuntu, chasquid can be installed by running:
+
+```shell
+sudo apt install chasquid
+```
+
+### From source
+
+To get, build and install from source, you will need a working
 [Go](http://golang.org) environment.
 
 ```shell
 # Get the code and build the binaries.
-go get blitiri.com.ar/go/chasquid
-cd "$GOPATH/src/blitiri.com.ar/go/chasquid"
+git clone https://blitiri.com.ar/repos/chasquid
+cd chasquid
 make
 
 # Install the binaries to /usr/local/bin.