Document build environment (#53)

2021-09-10 12:55:57 +02:00 · 2021-09-10 12:55:57 +02:00 · 4f627b96a7
parent 7e72caa092
commit 4f627b96a7
1 changed files with 18 additions and 0 deletions
--- a/doc/build_env.md
+++ b/doc/build_env.md
@ -0,0 +1,18 @@
+# Build environment
+## `go version`
+```
+go version go1.17 linux/amd64
+```
+## Build commands
+### Compile development version to check for errors
+```
+go install -race github.com/HimbeerserverDE/mt-multiserver-proxy/cmd/mt-multiserver-proxy
+```
+### Install and run latest version
+```
+go install -race github.com/HimbeerserverDE/mt-multiserver-proxy/cmd/mt-multiserver-proxy@latest && ~/go/bin/mt-multiserver-proxy
+```
+## Formatting
+```
+go fmt
+```