README updates

modified:   README.md
This commit is contained in:
Brian Barto 2016-04-22 16:40:16 -04:00
parent cca569ae4a
commit 9c91f6eeec

View File

@ -13,7 +13,7 @@ What's Provided
This project provides 2 tools for you to recreate this effect:
1. A standalone executable file named `nms`. This file accepts data via a shell pipe and displays it in a maner that nearly identically mimicks the effect we see in the movie.
1. A standalone executable file named `nms`. This file accepts data from a shell pipe and displays it in a manner that is nearly identical to the effect we see in the movie.
2. A module, written in C, that can be used for incorporating this effect in to other programs.
@ -28,15 +28,15 @@ make
This will create an executable file named `nms` and place it in the `no-more-secrets/bin/` directory.
You may manually copy it in to your preferred bin directory.
Usaging the Standalone Executable
---------------------------------
Using the Standalone Executable
-------------------------------
The `nms` binary accepts data via shell pipe. Simply pipe some data to it.
`nms` accepts data from a shell pipe. Simply pipe some data to it and enjoy the magic!
```
ls -l | bin/nms
```
Once the "encrypted" data is displayed, the program will pause until you press a key. Then the
decryption effect will start. After the decryption effect is completed, it will again pause until
decryption effect will start. After that is completed, it will again pause until
you press a key, at which point the program will terminate.
License