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

Update README

Browse Source 
modified:   README.md
This commit is contained in:
Brian Barto 2017-01-20 14:59:02 -05:00
parent 4b79262cf2
commit aeb2fbb904
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -19,10 +19,12 @@ user to select one of the menu options before it terminates.
![Screenshot](http://www.brianbarto.info/extern/images/nms/sneakers.gif) ![Screenshot](http://www.brianbarto.info/extern/images/nms/sneakers.gif)
This project has no dependencies, but it does rely on ANSI/VT100 escape By default, this project has no dependencies, but it does rely on ANSI/VT100
sequences to recreate the effect. Most modern terminal programs support terminal escape sequences to recreate the effect. Most modern terminal
these sequences so this should not be an issue for most users. If yours programs support these sequences so this should not be an issue for most
does not, you may need to use an alternate terminal program like xTerm. users. If yours does not, this project also provides a ncurses implementation
which supports non-ANSI terminals, but at the expense of losing the inline
functionality (ncurses will always clear the screen prior to displaying output).
Table of Contents Table of Contents
----------------- -----------------
@ -38,7 +40,7 @@ More and more unix/linux platforms are including this project in their
package manager. You may wish to search your package manager to see if it package manager. You may wish to search your package manager to see if it
is an installation option. If you install form a package manager, please is an installation option. If you install form a package manager, please
check that you have the latest version (`nms -v`). If not, I suggest check that you have the latest version (`nms -v`). If not, I suggest
installing from source (see below). installing from source by following the instructions below.
To install this project from source, you will need to have the tools `git`, 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 `gcc`, and `make` to download and build it. Install them from your package
@ -50,7 +52,8 @@ Once you have the necessary tools installed, follow these instructions:
``` ```
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
make make nms
make sneakers ## Optional
sudo make install sudo make install
``` ```
@ -60,6 +63,21 @@ sudo make install
$ sudo make uninstall $ sudo make uninstall
``` ```
#### Install with Ncurses Support
If your terminal does not support ANSI/VT100 escape sequences, the effect
may not render properly. This project provides a ncurses implementation
for such cases. You will need the ncurses library installed. Install this
library from your package manager. Next, follow these instructions:
```
git clone https://github.com/bartobri/no-more-secrets.git
cd ./no-more-secrets
make nms-ncurses
make sneakers-ncurses ## Optional
sudo make install
```
Usage Usage
----- -----
@ -70,7 +88,6 @@ enjoy the magic. In the below examples, I use a simple directory listing.
ls -l | nms 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 -r 123456 // Set return options
ls -l | nms -c // Clear screen ls -l | nms -c // Clear screen
nms -v // Display version nms -v // Display version
``` ```