Merge pull request #14 from cjvirtucio87/readme-fix

NA: cleanup; help command for gitversion

README.md

@@ -7,8 +7,6 @@ This is a project containing simple bash tools for general use.
 ## Current tools
 
 1. `gitversion`: a version retrieval tool that uses git depth for the PATCH version
-1. `vim-devc`: a script for setting up a devcontainer with the `vim` configs on the host machine
-    using the `devcontainer.json` of any given local workspace
 1. `stowsh`: a dotfiles managing tool
 
 ## Installing
@@ -25,12 +23,10 @@ curl \
 
 ## Usage
 
-Documentation is maintained on the code itself for maintainability reasons. Run `helpsh`
-on any of these scripts to see their usage information, e.g.:
+See the help message of each script for more info, e.g.:
 
 ```bash
-# assuming these scripts are in your $PATH
-helpsh vim-devc
+gitversion help
 ```
 
 ## Sample dockerfile

bash_tools/bin/gitversion

@@ -15,14 +15,25 @@ set -e
 ###   PATCH is appended to this MAJOR.MINOR to constitute the project's
 ###   SEMVER.
 
-ROOT_DIR="$(dirname "$0")"
-readonly ROOT_DIR
+function _help {
+  local line
+  while read -r line; do
+    if [[ "${line}" =~ ^### ]]; then
+      echo "${line/\#\#\#/}"
+    fi
+  done < "$(readlink -f "$0")"
+}
 
 function _get_newest_commit_versiontxt {
   git log -1 --pretty=format:"%h" -- './version.txt' | tr -d '\n'
 }
 
 function main {
+  if [[ "$1" =~ help ]]; then
+    _help | less
+    return
+  fi
+
   if [[ ! -f './version.txt' ]]; then
     >&2 echo 'missing version.txt file'
     return 1