diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index a7af073..9a6bc6d 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -3,6 +3,7 @@ * GNU or BSD [findutils](https://en.wikipedia.org/wiki/Find_(Unix)) * POSIX compatible [sh](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/sh.html) * [Ghostscript](https://www.ghostscript.com/) +* [git](https://git-scm.com/) 2.46.1+ * [ShellCheck](https://www.shellcheck.net/) 0.8.0+ * [Go](https://go.dev/) 1.23.2+ * [Python](https://www.python.org/) 3.12.1+ @@ -14,6 +15,41 @@ * [ASDF](https://asdf-vm.com/) 0.10 (run `asdf reshim` after provisioning) * [direnv](https://direnv.net/) 2 +# INSTALL + +(Adjust git forks, clone URLs, remotes, HEAD pointer, and/or local directory name as needed.) + +1. Clone the project to a local directory. + +```console +$ git clone https://github.com/mcandre/bao.git ~/bao +``` + +2. Add .../bao/bin to `PATH`. + +~/.zshrc: + +```zsh +# ... +export PATH="$PATH:$HOME/bao/bin" +``` + +# UNINSTALL + +1. Remove .../bao/bin from `PATH`. + +~/.zshrc: + +```zsh +# ... +``` + +2. Remove local clone directory. + +```console +$ rm -rf ~/bao +``` + # AUDIT ```console diff --git a/README.md b/README.md index d54cc76..9f7dcc5 100644 --- a/README.md +++ b/README.md @@ -28,18 +28,44 @@ Note: Sometimes Ghostscript can output files the same size or larger than the in BSD-2-Clause -# REQUIREMENTS +# RUNTIME REQUIREMENTS * POSIX compatible [sh](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/sh.html) * [Ghostscript](https://www.ghostscript.com/) +* [git](https://git-scm.com/) 2.46.1+ # INSTALL -Add .../bao/bin to `PATH`. +1. Clone the project to a local directory. + +```console +$ git clone https://github.com/mcandre/bao.git ~/bao +``` + +2. Add .../bao/bin to `PATH`. + +~/.zshrc: + +```zsh +# ... +export PATH="$PATH:$HOME/bao/bin" +``` # UNINSTALL -Remove .../bao/bin from `PATH`. +1. Remove .../bao/bin from `PATH`. + +~/.zshrc: + +```zsh +# ... +``` + +2. Remove local clone directory. + +```console +$ rm -rf ~/bao +``` # CONTRIBUTING