Updating README to include new 'make install' script.

modified:   README.md
This commit is contained in:
Brian Barto 2016-05-01 16:12:03 -04:00
parent 8aeecc1446
commit 94b1200497

View File

@ -12,8 +12,8 @@ perform this effect on piped data:
![Screenshot](http://i.imgur.com/ezF3xkN.gif) ![Screenshot](http://i.imgur.com/ezF3xkN.gif)
Here is another example program called "sneakers" (type `make sneakers` to build) that Also included in this project is a program called "sneakers" that utilizes these tools to recreate,
utilizes these tools to recreate, almost identically, what we see in the above movie clip. almost identically, what we see in the above movie clip.
![Screenshot](http://www.tackboard.world/no_more_secrets.gif) ![Screenshot](http://www.tackboard.world/no_more_secrets.gif)
@ -45,17 +45,18 @@ Next, download and build the standalone executable:
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
sudo make install
``` ```
This will create an executable file named `nms` and place it in the `no-more-secrets/bin/` directory. This will create and install an executable file `nms`. (Note that this also installs another
You may manually copy it into your preferred bin directory. executable file named `sneakers` which is shown above.)
Using the Standalone Executable Using the Standalone Executable
------------------------------- -------------------------------
`nms` accepts data from a shell pipe. Simply pipe some data to it and enjoy the magic! `nms` accepts data from a shell pipe. Simply pipe some data to it and enjoy the magic!
``` ```
ls -l | bin/nms ls -l / | nms
``` ```
Once the "encrypted" data is displayed, the program will pause until you press a key. Then the Once the "encrypted" data is displayed, the program will pause until you press a key. Then the
decryption effect will start. After that is completed, it will again pause until decryption effect will start. After that is completed, it will again pause until