Notes about setting GOPATH variable

Signed-off-by: Sergey Matveev <stargrave@stargrave.org>

diff --git a/INSTALL b/INSTALL
index c1f1dc35b3d48b40da980b07c3356192fdcd8261..f2be0e68936165ec0b96e42c3826cc23175dded1 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
 GoVPN is a program written on Go programming language. If you have set
 GoVPN is a program written on Go programming language. If you have set

-up $GOPATH environment, then simple "make all" should build govpn-client
-and govpn-server executable binaries.
+up $GOPATH environment properly, then simple "make all" should build
+govpn-client and govpn-server executable binaries.

 
 

-For usage documentation see either doc/govpn.info or doc/govpn.texi.
+For details see either doc/govpn.info or doc/govpn.texi.

diff --git a/doc/govpn.texi b/doc/govpn.texi
index e454198a3cc3167e8b168e6c54ac83c3da9cb4b3..9c53ba5b4214804d1ce44dec01b648ae8f704de6 100644 (file)
--- a/doc/govpn.texi
+++ b/doc/govpn.texi
@@ -129,9 +129,26 @@ are provided below, but be sure that you are reading them from the
 trusted source. Alternatively check this page from other sources and
 look for the mailing list announcements.
 
 trusted source. Alternatively check this page from other sources and
 look for the mailing list announcements.
 

-You have to set up @code{$GOPATH} properly first. After that you can
-just type @code{make} and all necessary Go libraries will be installed
-and client/server binaries are built in the current directory.
+You have to set up @code{$GOPATH} properly first. For example you can
+clone the repository or decompress tarball and set path like this:
+
+@example
+% mkdir -p govpn/src
+% git clone https://github.com/stargrave/govpn govpn/src/govpn
+or
+% tar xfC govpn-1.5.tar.xz govpn/src && mv govpn/src/govpn-1.5 govpn/src/govpn
+% export GOPATH=$(pwd)/govpn:$GOPATH
+@end example
+
+After that you can just type @code{make} and all necessary Go libraries
+will be installed and client/server binaries are built in the current
+directory:
+
+@example
+% cd govpn/src/govpn
+% make
+[or gmake under FreeBSD]
+@end example

 
 @include pubkey.texi
 
 
 @include pubkey.texi