README Updates
modified: README.md
This commit is contained in:
parent
3275cbf371
commit
cca569ae4a
17
README.md
17
README.md
@ -15,13 +15,10 @@ 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.
|
||||
|
||||
2. A module for incorporating this effect in to other programs.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
To install the standalone executable `nms` follow these steps:
|
||||
2. A module, written in C, that can be used for incorporating this effect in to other programs.
|
||||
|
||||
Installing the Standalone Executable
|
||||
------------------------------------
|
||||
```
|
||||
git clone https://github.com/bartobri/no-more-secrets.git
|
||||
cd ./no-more-secrets
|
||||
@ -31,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.
|
||||
|
||||
nms Usage
|
||||
---------
|
||||
Usaging the Standalone Executable
|
||||
---------------------------------
|
||||
|
||||
The `nms` binary accepts data via shell pipe. Simply pipe some data to it.
|
||||
```
|
||||
ls -l | nms
|
||||
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 descrytion effect is completed, it will again pause until
|
||||
decryption effect will start. After the decryption effect is completed, it will again pause until
|
||||
you press a key, at which point the program will terminate.
|
||||
|
||||
License
|
||||
|
Loading…
Reference in New Issue
Block a user