From 93c30fc438a3db133819065e605fb38e49873dc2 Mon Sep 17 00:00:00 2001 From: Dan Anglin Date: Sun, 25 Feb 2024 15:27:26 +0000 Subject: [PATCH] finished install section --- README.asciidoc | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.asciidoc b/README.asciidoc index 733cda7..a6e1663 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -43,7 +43,36 @@ during compilation. You can visit the https://magefile.org/[Mage website] for in ==== Install with mage -==== Install with go build +You can install Enbas with Mage using the following commands: +[source,console] +---- +git clone https://github.com/dananglin/enbas.git +cd enbas/internal/build/ +mage install +---- + +By default Mage will attempt to install Enbas to `/usr/local/bin/enbas` which will most likely fail as you won't +the permission to write to `/usr/local/bin/`. You will need to either run `sudo mage install`, or you can +(preferably) change the install prefix to a directory that you have permission to write to using +the `ENBAS_INSTALL_PREFIX` environment variable. For example: + +[source,console] +---- +ENBAS_INSTALL_PREFIX=${HOME}/.local mage install +---- + +This will install Enbas to `~/.local/bin/enbas`. + +==== Install with go + +If your `GOBIN` directory is included in your `PATH` then you can install Enbas with Go. + +[source,console] +---- +git clone https://github.com/dananglin/enbas.git +cd enbas +go install ./cmd/enbas +---- == Configuration