From 05021a76998bee655780f19afa7a6f1e635c46b5 Mon Sep 17 00:00:00 2001 From: James Tomasino Date: Sun, 12 May 2019 11:59:16 -0400 Subject: [PATCH] updated readme with BSD instructions --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d3b85d6..2b999d2 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,24 @@ ## Installation -### Install - -`sudo make install` - _Note: On systems without admin access the binary can be run directly from the git repo, but will lack `man` support and command completion._ See the [Getting Started](https://github.com/jamestomasino/burrow/wiki/Getting-Started) guide. +### Install on Linux / MacOS + +`sudo make install` + +### Install on BSD systems + +- Installing bash-completion via either `pkg install bash-completion` or via the `shells/bash-completion` port. +- Installing the GNU version of make via either `pkg install gmake` or the `port devel/gmake`. +- Rather than running `sudo make install`, run `sudo gmake install`. + ### Uninstall -`sudo make uninstall` +`sudo make uninstall` # or gmake uninstall on BSD ## Usage