From e8511e3f5589ba6979fe4e6f4cfece5685c01ea2 Mon Sep 17 00:00:00 2001 From: Alberto Bertogli Date: Fri, 25 Oct 2019 15:57:03 +0100 Subject: [PATCH] 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 | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) 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.