From: Ethan Kinnear Date: Sun, 10 Jul 2022 13:48:57 +0000 (-0500) Subject: Add Homebrew installation info to `README.md` (#133) X-Git-Tag: v0.2.0.2~178 X-Git-Url: https://glassweightruler.freedombox.rocks/gitweb/xdg-ninja.git/commitdiff_plain/e537b63b188a46df06f761f0c6b7c7838e77d0d6 Add Homebrew installation info to `README.md` (#133) Co-authored-by: b3nj5m1n <47924309+b3nj5m1n@users.noreply.github.com> --- diff --git a/README.md b/README.md index 9070615..68fa299 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,16 @@ The configurations are from the [arch wiki page on XDG_BASE_DIR](https://wiki.ar ## Running +### Cloning Manually + Clone the repository somewhere, then run the _./xdg-ninja.sh_ script. This will run every test in the default configuration. +### Installing with Homebrew + +To install xdg-ninja with [Homebrew](https://brew.sh), run `brew install xdg-ninja` to install the script and all of its dependencies, then run the `xdg-ninja` command. + ## Dependencies - your favorite POSIX-compliant shell ([bash](https://repology.org/project/bash/packages), [zsh](https://repology.org/project/zsh/packages), [dash](https://repology.org/project/dash-shell/packages), ...)