From 5f63653ff340d7a405b924ab586e92e4f08ff25c Mon Sep 17 00:00:00 2001 From: Brian Barto Date: Mon, 25 Apr 2016 16:45:52 -0400 Subject: [PATCH] More README Updates modified: README.md --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3349a2d..fc25779 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,9 @@ What's Provided Two tools are provided for you to recreate this effect: -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. +1. A standalone executable file named `nms` (shown above). 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 included in programs and used to recreate this effect in a custonized way. In fact, the standalone executable `nms` is really just an example that shows how to use this module on piped data. +2. A module and header file, written in C, that can be included in programs and used to recreate this effect in a custonized way. In fact, the standalone executable `nms` is really just an example that shows how to use this module on piped data. Installing the Standalone Executable ------------------------------------ @@ -48,6 +48,27 @@ Once the "encrypted" data is displayed, the program will pause until you press a decryption effect will start. After that is completed, it will again pause until you press a key, at which point the program will terminate. +Using the Modules in Your Program +--------------------------------- + +You will need to copy two files to your project: + +``` +nms.h +nms.c +``` +Include `nms.h` in your program file: + +``` +#include +``` +Add nms.c to your source file list when compiling: +``` +gcc nms.c myprog.c -o myprog +``` + + + License -------