README: Add 'Building from source' section

HenrikBengtsson · May 18, 2024 · a64a2d4 · a64a2d4
1 parent b935918
commit a64a2d4
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -233,7 +233,7 @@ Useful resources:
 * UCSF Managing Your Passwords:
   - https://it.ucsf.edu/services/managing-your-passwords
 
-Version: 5.7.0-9033
+Version: 5.7.0-9034
 Copyright: Henrik Bengtsson (2016-2024)
 License: GPL (>= 2.1) [https://www.gnu.org/licenses/gpl.html]
 Source: https://github.com/HenrikBengtsson/ucsf-vpn
@@ -284,5 +284,20 @@ The `ucsf-vpn` software _neither_ collects nor stores your local or UCSF
 credentials.
 
 
+## Building from source
+
+The self-contained `bin/ucsf-vpn` script is generated from
+`src/ucsf-vpn.sh` and `src/incl/*.sh`. The rebuild `bin/ucsf-vpn`,
+use:
+
+```sh
+$ make build
+./build.sh
+Building bin/ucsf-vpn from src/ucsf-vpn ...
+-rwxrwxr-x 1 alice henrik alice May 18 09:34 bin/ucsf-vpn
+Version built: 5.8.0
+Building bin/ucsf-vpn from src/ucsf-vpn ... done
+```
+
 [NEWS]: NEWS.md
 [UCSF VPN web proxy]: https://remote-vpn01.ucsf.edu/
diff --git a/README.md.tmpl b/README.md.tmpl
@@ -144,5 +144,20 @@ The `ucsf-vpn` software _neither_ collects nor stores your local or UCSF
 credentials.
 
 
+## Building from source
+
+The self-contained `bin/ucsf-vpn` script is generated from
+`src/ucsf-vpn.sh` and `src/incl/*.sh`. The rebuild `bin/ucsf-vpn`,
+use:
+
+```sh
+$ make build
+./build.sh
+Building bin/ucsf-vpn from src/ucsf-vpn ...
+-rwxrwxr-x 1 alice henrik alice May 18 09:34 bin/ucsf-vpn
+Version built: 5.8.0
+Building bin/ucsf-vpn from src/ucsf-vpn ... done
+```
+
 [NEWS]: NEWS.md
 [UCSF VPN web proxy]: https://remote-vpn01.ucsf.edu/
diff --git a/build.sh b/build.sh
@@ -1,4 +1,4 @@
-tmpl=${1:-src/ucsf-vpn}
+tmpl=${1:-src/ucsf-vpn.sh}
 target=${2:-bin/ucsf-vpn}
 
 echo "Building ${target} from ${tmpl} ..."

diff --git a/src/ucsf-vpn → src/ucsf-vpn.sh b/src/ucsf-vpn → src/ucsf-vpn.sh