Author: Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com>
Improve documentation with newer commands
docs/t.1 | 78 ++++++++++++++++++++++++++++++++----------------------- docs/t.txt | 27 +++++++++++++++++++
diff --git a/docs/t.1 b/docs/t.1 index 97f6cdcffe9e8b4128f92719abcef76f2100e6cb..524cb97747188288df6e3e95071424fdee48bcf4 100644 --- a/docs/t.1 +++ b/docs/t.1 @@ -1,37 +1,49 @@ -.TH t 1 +.TH t 1 "21 March 2020" "" "General User Commands" .SH NAME -t \- manage your notes +\fBt \fP- The simplest note taker .SH SYNOPSIS -.B t -[\fB\-l\fR] -[\fB\-c\fR \f\\'Title of your note'\fR] -[\fB\-e\fR \f\index\fR] - +.nf +.fam C +\fBt\fP <command> +.fam T +.fi +.fam T +.fi .SH DESCRIPTION -.B t -a simple utility to manage your notes using Markdown - -.SH OPTIONS - -.TP -.B \-l -List all notes created by the modification date - -.TP -.BR \fB\-c\fR \ 'Title\ of\ your\ note' -Create a new note using the title you specified or -generate one using the current time - -.TP -.BR \-e \ \f\index\fR -Edit a note fetching by it's index where zero it's -the most recent note - -.SH LICENSE - -t is licensed under GNU GPL v3. You can get yourself a copy on LICENSE file. - +\fBt\fP manage notes for you using git and your editor of choice. It will +store notes at your home directory 'notes' folder. +.SH COMMANDS +There's three commands avaiable for `\fBt\fP`. *Create*, *List* and *Edit* +.RS +.IP \(bu 3 +create <Title> +.PP +.nf +.fam C + It will use the supplied title to create a new note on your + NOTE_DIR or will generate a title using the current date-time. +.fam T +.fi +.IP \(bu 3 +list +.PP +.nf +.fam C + List all notes by descending order +.fam T +.fi +.IP \(bu 3 +edit <Index> +.PP +.nf +.fam C + Edit a note by the giving index (by descending order). If no + supplied index, will edit the last created note. +.fam T +.fi .SH AUTHORS - -t is an free and open source project. It's being maintained by Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com> -and hosted on https://git.sr.ht/~porcellis/t. +`\fBt\fP` is maintained by Pedro Lucas Porcellis <porcellis@eletrotupi.com> +and you can get yourself a copy at https://git.sr.ht/~porcellis/\fBt\fP +.SH CONTRIBUTING +You can send patches, file bugs and discuss the project by sending an +email to <porcellis@eletrotupi.com> diff --git a/docs/t.txt b/docs/t.txt new file mode 100644 index 0000000000000000000000000000000000000000..29d9a5712cd0d56679ba71f8fc74980d8e7f67a9 --- /dev/null +++ b/docs/t.txt @@ -0,0 +1,27 @@ +NAME + t - The simplest note taker +SYNOPSIS + t <command> +DESCRIPTION + t manage notes for you using git and your editor of choice. It will + store notes at your home directory 'notes' folder. +COMMANDS + There's three commands avaiable for `t`. *Create*, *List* and *Edit* + + * create <Title> + + It will use the supplied title to create a new note on your + NOTE_DIR or will generate a title using the current date-time. + * list + + List all notes by descending order + * edit <Index> + + Edit a note by the giving index (by descending order). If no + supplied index, will edit the last created note. +AUTHORS + `t` is maintained by Pedro Lucas Porcellis <porcellis@eletrotupi.com> + and you can get yourself a copy at https://git.sr.ht/~porcellis/t +CONTRIBUTING + You can send patches, file bugs and discuss the project by sending an + email to <porcellis@eletrotupi.com>