aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHimbeerserverDE <himbeerserverde@gmail.com>2023-12-06 17:26:52 +0100
committerHimbeerserverDE <himbeerserverde@gmail.com>2023-12-06 17:27:03 +0100
commite7e3246ca926054162af49ae6bae1877df5ce9c6 (patch)
treee26fc215a09c60e6f1b89d4f60aae7bfd6df23da
parent41363f8c344b5d21cb61d1d064c73ea18c432934 (diff)
readme: installation: recommend overwriting GOBIN
This commit closes #135.
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5541822..94e08c7 100644
--- a/README.md
+++ b/README.md
@@ -57,9 +57,15 @@ and experience major breakage.** This is because the protocol version
isn't bumped when a new development phase is started after a release.
## Installation
+It is recommended to explicitly set the `GOBIN` environment variable
+to a directory that is only used for the proxy binaries, databases
+and configuration files.
+
Go 1.21 or higher is required. Run
```
+export GOBIN=~/.local/share/mt-multiserver-proxy
+mkdir -p ${GOBIN}
go install github.com/HimbeerserverDE/mt-multiserver-proxy/cmd/...@latest
```