From 5da646fb6fa6bcb4fe0530fef0e308bb165604fe Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Thu, 24 Dec 2020 08:54:37 +0100 Subject: [PATCH] doc: install from binary --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4ff60c6..0921cc2 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,24 @@ a private API URL with `--apiurl`. ## Installation -To install this tool, make sure you have `go 1.13.x` (or later) and `make` -installed and run the following commands: +The easiest way to install `chantools` is to [download a pre-built binary for +your operating system and architecture](https://github.com/guggero/chantools/releases). + +Example (make sure you always use the latest version!): + +```shell +$ cd /tmp +$ wget -O chantools.tar.gz https://github.com/guggero/chantools/releases/download/v0.7.1/chantools-linux-amd64-v0.7.1.tar.gz +$ tar -zxvf chantools.tar.gz +$ sudo mv chantools-*/chantools /usr/local/bin/ +``` + +### Compile from source + +If there isn't a pre-built binary for your operating system or architecture +available or you want to build `chantools` from source for another reason, you +need to make sure you have `go 1.13.x` (or later) and `make` installed and can +then run the following commands: ```bash git clone https://github.com/guggero/chantools.git