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

Spelling errors

Browse Source 
modified:   README.md
This commit is contained in:
Brian Barto 2016-04-26 12:19:17 -04:00
parent 53715bf7f6
commit 62c587e40e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -35,7 +35,7 @@ make
``` ```
This will create an executable file named `nms` and place it in the `no-more-secrets/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. You may manually copy it into your preferred bin directory.
Using the Standalone Executable Using the Standalone Executable
------------------------------- -------------------------------
@ -95,7 +95,7 @@ INIT_NMSARGS is a defined name that assigns a default set of values to all of th
is recommended that you use it. If you don't, you will have to manually assign a value to each is recommended that you use it. If you don't, you will have to manually assign a value to each
structure member. structure member.
Here is how the structre is defined: Here is how the structure is defined:
``` ```
typedef struct { typedef struct {
char *src; char *src;
@ -111,9 +111,9 @@ typedef struct {
Useful for displaying menus: Useful for displaying menus:
* `char *return_opts` * `char *return_opts`
* String pointer containg only the character options that the user must choose from once the src characters are revealed. For example, if you are showing a menu with six options, this string might be "123456". The user will have to choose one of these characters before execution is handed back to the calling function. Note that the character selected is returned by `nms_exec()`; * String pointer containing only the character options that the user must choose from once the src characters are revealed. For example, if you are showing a menu with six options, this string might be "123456". The user will have to choose one of these characters before execution is handed back to the calling function. Note that the character selected is returned by `nms_exec()`;
* `int input_cursor_x` and `int input_cursor_y` * `int input_cursor_x` and `int input_cursor_y`
* If your menu has a specific location that you'd like to place the cursor for user input, use these to set the x and y screen corrdinates for the position. * If your menu has a specific location that you'd like to place the cursor for user input, use these to set the x and y screen coordinates for the position.
* `bool show_cursor` * `bool show_cursor`
* Set to `true` if you want the cursor to be visible during the text decryption effect. It is set to `false` by default. * Set to `true` if you want the cursor to be visible during the text decryption effect. It is set to `false` by default.