Author: Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com>
Generate a simple and nice doc
Makefile | 5 ++++- docs/t.1 | 37 +++++++++++++++++++++++++++++++++++++
diff --git a/Makefile b/Makefile index 6aaebaf05ae6ed45d0699db9554f64c3c6bd260d..e55a11d185802f8b0ca97ed1a77d918d9bd15a92 100644 --- a/Makefile +++ b/Makefile @@ -8,6 +8,9 @@ .go: mkdir -p $(dir $(PKGPATH)) ln -fTrs $(realpath .) $(PKGPATH) +doc: + gzip -c docs/t.1 > docs/t.1.gz + t: .go env GOPATH=$(GOPATH) go build -o $@ ./main.go @@ -18,4 +21,4 @@ clean: rm -rf t .PHONY: - t get clean + t get clean doc diff --git a/docs/t.1 b/docs/t.1 new file mode 100644 index 0000000000000000000000000000000000000000..97f6cdcffe9e8b4128f92719abcef76f2100e6cb --- /dev/null +++ b/docs/t.1 @@ -0,0 +1,37 @@ +.TH t 1 +.SH NAME +t \- manage your notes +.SH SYNOPSIS +.B t +[\fB\-l\fR] +[\fB\-c\fR \f\\'Title of your note'\fR] +[\fB\-e\fR \f\index\fR] + +.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. + +.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.