greg/no-more-secrets-rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add version option to README. Also some minor word changes to the install instructions.

Browse Source 
modified:   ../README.md
This commit is contained in:
Brian Barto 2017-01-12 16:59:56 -05:00
parent 15d033a93c
commit 1f59129b1a
1 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -37,28 +37,20 @@ package manager collection. If you're using one of the following systems,
you can install it from the package manager. you can install it from the package manager.
* openSUSE * openSUSE
* Homebrew (Mac OS X, see http://brew.sh/) * Mac OS X (Via homebrew package manager: http://brew.sh/)
* FreeBSD * FreeBSD
If your system is not on the list, you can easily install this project from If you install form a package manager, please check that you have the
source. You will need to have `git`, `gcc`, and `make` installed to download latest version (`nms -v`). If not, I suggest installing from source (see
and build it. Install them from your package manager if they are not available. below).
To check if you have them installed: To install this project from source, you will need to have the tools `git`,
`gcc`, and `make` to download and build it. Install them from your package
manager if they are not available.
``` Once you have the necessary tools installed, follow these instructions:
$ which make
/usr/bin/make
$ which gcc
/usr/bin/gcc
$ which git
/usr/bin/git
```
Once those are installed, follow these instructions to download and install `nms`.
#### Install:
``` ```
git clone https://github.com/bartobri/no-more-secrets.git git clone https://github.com/bartobri/no-more-secrets.git
cd ./no-more-secrets cd ./no-more-secrets
@ -66,7 +58,7 @@ make
sudo make install sudo make install
``` ```
Uninstall: #### Uninstall:
``` ```
$ sudo make uninstall $ sudo make uninstall
@ -86,6 +78,7 @@ ls -l / | nms
ls -l / | nms -a // Set auto-decrypt flag ls -l / | nms -a // Set auto-decrypt flag
ls -l / | nms -f green // Set foreground color to green ls -l / | nms -f green // Set foreground color to green
ls -l / | nms -c // Clear screen ls -l / | nms -c // Clear screen
ls -l / | nms -v // Display version
``` ```
#### Command Line Options #### Command Line Options
@ -108,6 +101,10 @@ it saves the state of the terminal (all current output), and restores it
once the effect is comlpeted. Note that when using this option, `nms` requires once the effect is comlpeted. Note that when using this option, `nms` requires
the user to press a key before restoring the terminal. the user to press a key before restoring the terminal.
`-v`
Display version info.
License License
------- -------