From 7d48a6fe851227755489975b9b81780e240fa970 Mon Sep 17 00:00:00 2001 From: Brian Barto Date: Wed, 11 Jan 2017 21:00:47 -0500 Subject: [PATCH] Update install instructions modified: README.md --- README.md | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dfbcaf3..bda897e 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,19 @@ Table of Contents Download and Install -------------------- -In order to download and build this project, you will need to have `git`, -`gcc`, and `make` installed. Install them from your package manager if not -already installed. +I am flattered that few *NIX platforms have added this project to their +package manager collection. If you're using one of the following systems, +you can install it from the package manager. + +* openSUSE +* Homebrew (Mac OS X, see http://brew.sh/) +* FreeBSD + +If your system is not on the list, you can easily install this project from +source. You will need to have `git`, `gcc`, and `make` installed to download +and build it. Install them from your package manager if they are not available. + +To check if you have them installed: ``` $ which make @@ -42,8 +52,20 @@ $ which git /usr/bin/git ``` -See the [INSTALL](INSTALL.md) file for a list of instructions for various -operating systems. +Once those are installed, follow these instructions to download and install `nms`. + +``` +git clone https://github.com/bartobri/no-more-secrets.git +cd ./no-more-secrets +make +sudo make install +``` + +Uninstall: + +``` +$ sudo make uninstall +``` Usage -----