Prepared documentation for release 0.5.0

CHANGELOG.md

@@ -14,7 +14,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 ```
 
-## [0.4.0] - 2023-01-04
+## [0.5.0] - 2024-01-15
+### Changed
+- Changed the Kerberos username variable used in `kload` alias `KRB_PRINCIPAL` -> `KRB5_PRINCIPAL`.
+
+
+## [0.4.0] - 2023-01-14
 ### Added
 - Configurations can now share a common Makefile which allows for configuration specific
   customizations to added using hook targets: `hook-check`, `hook-install`, `hook-test`, and

README.md

@@ -8,6 +8,31 @@ supported configurations include the following:
 - MacOS client running VNC
 - Linux servers supporting VNC
 
+## Installation
+
+The user configuration files can installed using the code snippet below.
+
+```bash
+curl -sL https://github.com/ic-designer/fnal-asic-compute/archive/refs/tags/0.5.0.tar.gz | tar xz
+make -C fnal-asic-compute-0.5.0 install
+```
+
+The Makefile will use information about the operating system to determine which configuration to
+install. As shown below, the Makefile first determines the operating system, then passes the
+target to the configuration specific target.
+
+```make
+UNAME_OS:=$(shell sh -c 'uname -s 2>/dev/null')
+ifeq ($(UNAME_OS),Darwin)
+    TARGET_CONFIG := fnal-asic-config-macos-client
+else ifeq ($(UNAME_OS),Linux)
+    TARGET_CONFIG := fnal-asic-config-linux-server
+else
+    $(error Unsupported operating system, $(UNAME_OS))
+endif
+SRCDIR_ROOT = $(TARGET_CONFIG)
+```
+
 ## Configurations
 
 ### MacOS Client
@@ -20,13 +45,12 @@ The macOS client configuration provides the following user configuation files:
 
 The envirnment variables provided below are also supported. These variables can be uniquely set
 for each user by adding to the override file `~/.zshrc_local`.
-- `KRB_PRINCIPAL` - Overrides the default kerebros principal if defined.
+- `KRB5_PRINCIPAL` - Overrides the default kerebros principal if defined.
 
 The MacOS client configuration also installs `vnctools` to help manage VNC connections.
 
 [VNC Tools Command Reference](https://github.com/ic-designer/bash-vnctools/blob/d60f8c8697f0d56824c01a4dd6593d126c65e9dd/README.md)
 
-
 ### Linux Server
 
 The Linux server configuration provides the following user configuation files:
@@ -36,38 +60,6 @@ The Linux server configuration provides the following user configuation files:
 - `~/.bashrc` - Base bash run command file.
 - `~/.bash_profile` - Base profile file.
 
-
-## Installation
-
-The user configuration files can installed using the code snippet below.
-
-```bash
-curl -sL https://github.com/ic-designer/fnal-asic-compute/archive/refs/tags/0.4.0.tar.gz | tar xz
-make -C fnal-asic-compute-0.4.0 install
-```
-
-The Makefile will use information about the operating system to determine which configuration to
-install. As shown below, the Makefile first determines the operating system, then passes the
-target to the configuration specific target.
-
-```make
-UNAME_OS:=$(shell sh -c 'uname -s 2>/dev/null')
-ifeq ($(UNAME_OS),Darwin)
-    TARGET_CONFIG := fnal-asic-macos-config
-else ifeq ($(UNAME_OS),Linux)
-    TARGET_CONFIG := fnal-asic-linux-config
-else
-    $(error Unsupported operating system, $(UNAME_OS))
-endif
-
-...
-
-%:
-	$(MAKE) -C $(TARGET_CONFIG) -I $(CURDIR)/make $(MAKECMDGOALS)
-
-```
-
-
 ## Make Targets
 
 The supported make targets are shown below.
@@ -77,7 +69,6 @@ The supported make targets are shown below.
 - `test` - Same as `check`.
 - `uninstall` - Uninstalls the configuration files.
 
-
 ```make
 .PHONY: check
 check: private_test