commit ef74744e0f03db85563567a114ba506afd074740 parent 9aa8b046e4afd2306021ddc2c2ee36340c96e84a Author: Ed van Bruggen <edvb54@gmail.com> Date: Fri, 17 Mar 2017 22:26:46 -0700 Add usage section to README and man page Diffstat:
| README.md | | | 64 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| config.mk | | | 2 | -- |
| nt.1 | | | 97 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- |
3 files changed, 159 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md @@ -28,6 +28,70 @@ Simple note taker for the command line. -d *NOTE* Delete *NOTE* from notes +## USAGE + +Add simple note and list it: + + $ nt clean dishes + $ nt -l + clean dishes + +Create note in specified file: + + $ nt -f list take out trash + $ nt -f list -l + take out trash + +Add more notes by running command again: + + $ nt wash car + $ nt -l + clean dishes + wash car + $ nt buy pie + $ nt -l + clean dishes + wash car + buy pie + +List just the *NUM* most recent notes: + + $ nt -1 + buy pie + $ nt -n 1 + buy pie + $ nt -2 + buy pie + wash car + $ nt -n 2 + buy pie + wash car + +Search notes with a specified term: + + $ nt -s pie + buy pie + $ nt make pie + $ nt -s pie + buy pie + make pie + +Remove given note: + + $ nt -d buy pie + $ nt -l + clean dishes + wash car + make pie + +Edit note with new text given from stdin: + + $ echo eat pie | nt -e make pie + $ nt -l + clean dishes + wash car + eat pie + ## AUTHOR Ed van Bruggen <edvb54@gmail.com> diff --git a/config.mk b/config.mk @@ -1,8 +1,6 @@ # nt version number VERSION = 0.0.0 -### Change the variables below for your system - # paths PREFIX = /usr/local MANPREFIX = ${PREFIX}/share/man diff --git a/nt.1 b/nt.1 @@ -27,12 +27,105 @@ Simple note taker for the command line. .PP \-d \fINOTE\fP Delete \fINOTE\fP from notes +.SH USAGE +.PP +Add simple note and list it: +.PP +.RS +.nf +$ nt clean dishes +$ nt \-l +clean dishes +.fi +.RE +.PP +Create note in specified file: +.PP +.RS +.nf +$ nt \-f list take out trash +$ nt \-f list \-l +take out trash +.fi +.RE +.PP +Add more notes by running command again: +.PP +.RS +.nf +$ nt wash car +$ nt \-l +clean dishes +wash car +$ nt buy pie +$ nt \-l +clean dishes +wash car +buy pie +.fi +.RE +.PP +List just the \fINUM\fP most recent notes: +.PP +.RS +.nf +$ nt \-1 +buy pie +$ nt \-n 1 +buy pie +$ nt \-2 +buy pie +wash car +$ nt \-n 2 +buy pie +wash car +.fi +.RE +.PP +Search notes with a specified term: +.PP +.RS +.nf +$ nt \-s pie +buy pie +$ nt make pie +$ nt \-s pie +buy pie +make pie +.fi +.RE +.PP +Remove given note: +.PP +.RS +.nf +$ nt \-d buy pie +$ nt \-l +clean dishes +wash car +make pie +.fi +.RE +.PP +Edit note with new text given from stdin: +.PP +.RS +.nf +$ echo eat pie | nt \-e make pie +$ nt \-l +clean dishes +wash car +eat pie +.fi +.RE .SH AUTHOR .PP -Ed van Bruggen \<edvb54@gmail.com\> +Ed van Bruggen +\<edvb54@gmail.com\> .SH SEE ALSO .PP -View source code at: \<https://gitlab.com/edvb/nt\> +View source code at: +\<https://gitlab.com/edvb/nt\> .SH LICENSE .PP zlib License