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

README updates

Browse Source 
modified:   README.md
This commit is contained in:
Brian Barto 2016-04-22 16:25:21 -04:00
parent 555ed4fcd3
commit 3275cbf371
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -8,31 +8,31 @@ This project seeks to recreate the infamous "decrypting text effect" seen on scr
movie "Sneakers". If You are unfamiliar with the scene, the specific effect in question appears at movie "Sneakers". If You are unfamiliar with the scene, the specific effect in question appears at
0:35 in [this youtube video](https://www.youtube.com/watch?v=F5bAa6gFvLs). 0:35 in [this youtube video](https://www.youtube.com/watch?v=F5bAa6gFvLs).
What's Provided
---------------
This project provides 2 tools for you to recreate this effect: 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 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. 2. A module for incorporating this effect in to other programs.
License
-------
This program is free software; you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation; either version 3 of the License,
or (at your option) any later version. See [COPYING](COPYING) for more details.
Installation Installation
------------ ------------
To install the standalone executable `nms` follow these steps:
``` ```
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
``` ```
This will create the executable file bin/nms. You may copy it in to your preferred bin directory. 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.
Usage nms Usage
----- ---------
The `nms` binary accepts data via shell pipe. Simply pipe some data to it. The `nms` binary accepts data via shell pipe. Simply pipe some data to it.
``` ```
@ -41,3 +41,10 @@ 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 the descrytion effect is completed, it will again pause until decryption effect will start. After the descrytion effect is completed, it will again pause until
you press a key, at which point the program will terminate. you press a key, at which point the program will terminate.
License
-------
This program is free software; you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation; either version 3 of the License,
or (at your option) any later version. See [COPYING](COPYING) for more details.