From abcaa583122e400734c3125616bef77461f038c0 Mon Sep 17 00:00:00 2001 From: ASDFGamer Date: Wed, 19 Apr 2023 03:06:00 +0800 Subject: [PATCH] Improve Compilation Section in Readme (#543) This PR adds two small improvements to the compilation Section of the Readme: - Add go/The Go Programming Language to the list of required tools in the compilation section of the readme. - Add a short explanation how the compiled source can be installed via make install, with a note about the GOPATH Co-authored-by: Christoph Wildhagen Reviewed-on: https://gitea.com/gitea/tea/pulls/543 Reviewed-by: John Olheiser Reviewed-by: techknowlogick Co-authored-by: ASDFGamer Co-committed-by: ASDFGamer --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 19811e9..7b71d02 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,11 @@ Make sure you have a current go version installed (1.13 or newer). make ``` Note that GNU Make (gmake on OpenBSD) is required. + If you want to install the compiled program you have to execute the following command: + ```sh + make install + ``` + This installs the binary into the "bin" folder inside of your GOPATH folder (`go env GOPATH`). It is possible that this folder isn't in your PATH Environment Variable. - For a quick installation without `git` & `make`, set $version and exec: ```sh