Some initial info for README
modified: README.md
This commit is contained in:
parent
125cf82b42
commit
26c5cbbd32
40
README.md
40
README.md
@ -1,2 +1,38 @@
|
||||
# no-more-secrets
|
||||
TBD
|
||||
No More Secrets
|
||||
===============
|
||||
|
||||
What
|
||||
----
|
||||
|
||||
This project seeks to recreate the infamous "decrypting text effect" seen on screen in the 1992 hacker
|
||||
movie "Sneakers".
|
||||
|
||||
More description coming...
|
||||
|
||||
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
|
||||
------------
|
||||
```
|
||||
git clone https://github.com/bartobri/no-more-secrets.git
|
||||
cd ./no-more-secrets
|
||||
make
|
||||
```
|
||||
|
||||
This will create the executable file bin/nms. You may copy it in to your preferred bin directory.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
The `nms` binary accepts data via shell pipe. Simply pipe some data to it.
|
||||
```
|
||||
ls -l | 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
|
||||
you press a key, at which point the program will terminate.
|
||||
|
Loading…
Reference in New Issue
Block a user