add man page

Makefile

@@ -29,6 +29,11 @@ test:
 install:
 	go install ./cmd/...
 
+man/pomo.1: man/pomo.1.scd
+	scdoc < $< > $@
+
+manpages: man/pomo.1
+
 docs: www/data/readme.json
 	cd www && hugo -d ../docs
 

README.md

@@ -49,7 +49,7 @@ pomo start -t my-project "write some codes"
 
 ## Configuration
 
-Pomo has a few configuration options which can be read from a JSON file in Pomo's state directory `~/.pomo/config.json`.
+Pomo has a few configuration options which can be read from a JSON file in Pomo's config directory `~/.config/pomo/config.json`.
 
 ### colors
 

man/pomo.1

@@ -0,0 +1,89 @@
+.\" Generated by scdoc 1.11.2
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "pomo" "1" "2022-05-30"
+.P
+.SH NAME
+.P
+\fBPomo\fR is a simple CLI for using the Pomodoro Technique.\&
+.P
+.SH SYNOPSIS
+.P
+\fBpomo\fR [OPTIONS] COMMAND [arg.\&.\&.\&]
+.P
+.SH DESCRIPTION
+.P
+\fBpomo\fR helps you track what you did, how long it took you to do it, 
+and how much effort you expect it to take.\&
+.P
+The Pomodoro Technique is simple and effective:
+.P
+.RS 4
+\fB\fR Decide on a task you want to accomplish
+\fB\fR Break the task into timed intervals (pomodoros), [approx.\& 25 min]
+\fB\fR After each pomodoro take a short break [approx.\& 3 - 5 min]
+\fB\fR Once all pomodoros are completed take a longer break [approx 15 - 20 min]
+\fB\fR Repeat
+.P
+.RE
+.SH SUBCOMMANDS 
+.P
+See --help for the complete command usage
+.P
+.nf
+.RS 4
+  start, s        start a new task
+  init            initialize the sqlite database
+  config, cf      display the current configuration
+  create, c       create a new task without starting
+  begin, b        begin requested pomodoro
+  list, l         list historical tasks
+  delete, d       delete a stored task
+  status, st      output the current status
+
+.fi
+.RE
+.P
+.SH CONFIGURATION
+.P
+Pomo has a configuration file that is stored in \fB~/.\&config/pomo/config.\&json\fR.\&
+.P
+.nf
+.RS 4
+{
+	"colors": null,
+	"dateTimeFmt": "2006-01-02 15:04",
+	"publish": false,
+	"publishJson": false,
+	"publishSocketPath": ""
+}
+.fi
+.RE
+.P
+.SH EXAMPLES
+.P
+.SS GETTING STARTED
+.P
+.nf
+.RS 4
+# ensure your database has been initialized
+pomo init
+# run a new pomodoro
+pomo start -t my-project "write some code"
+# once finished view previously completed pomodoros
+pomo list
+.fi
+.RE
+.P
+.SH SEE ALSO
+.P
+See the pomo source repository on Github at https://github.\&com/kevinschoon/pomo for complete documentation.\&
+.P
+.SH AUTHORS
+.P
+Written by Kevin Schoon <me@kevinschoon.\&com> with help from the open source
+community.\&

man/pomo.1.scd

@@ -0,0 +1,74 @@
+pomo(1)
+
+# NAME
+
+*Pomo* is a simple CLI for using the Pomodoro Technique.
+
+# SYNOPSIS
+
+*pomo* [OPTIONS] COMMAND [arg...]
+
+# DESCRIPTION
+
+*pomo* helps you track what you did, how long it took you to do it, 
+and how much effort you expect it to take.
+
+The Pomodoro Technique is simple and effective:
+
+	** Decide on a task you want to accomplish
+	** Break the task into timed intervals (pomodoros), [approx. 25 min]
+	** After each pomodoro take a short break [approx. 3 - 5 min]
+	** Once all pomodoros are completed take a longer break [approx 15 - 20 min]
+	** Repeat
+
+# SUBCOMMANDS 
+
+See --help for the complete command usage
+
+```
+  start, s        start a new task
+  init            initialize the sqlite database
+  config, cf      display the current configuration
+  create, c       create a new task without starting
+  begin, b        begin requested pomodoro
+  list, l         list historical tasks
+  delete, d       delete a stored task
+  status, st      output the current status
+
+```
+
+# CONFIGURATION
+
+Pomo has a configuration file that is stored in *~/.config/pomo/config.json*.
+
+```
+{
+	"colors": null,
+	"dateTimeFmt": "2006-01-02 15:04",
+	"publish": false,
+	"publishJson": false,
+	"publishSocketPath": ""
+}
+```
+
+# EXAMPLES
+
+## GETTING STARTED
+
+```
+# ensure your database has been initialized
+pomo init
+# run a new pomodoro
+pomo start -t my-project "write some code"
+# once finished view previously completed pomodoros
+pomo list
+```
+
+# SEE ALSO
+
+See the pomo source repository on Github at https://github.com/kevinschoon/pomo for complete documentation.
+
+# AUTHORS
+
+Written by Kevin Schoon <me@kevinschoon.com> with help from the open source
+community.