+169 -1 +/-4 browse
1 | diff --git a/Makefile b/Makefile |
2 | index 2387871..92cb50c 100644 |
3 | --- a/Makefile |
4 | +++ b/Makefile |
5 | @@ -29,6 +29,11 @@ test: |
6 | install: |
7 | go install ./cmd/... |
8 | |
9 | + man/pomo.1: man/pomo.1.scd |
10 | + scdoc < $< > $@ |
11 | + |
12 | + manpages: man/pomo.1 |
13 | + |
14 | docs: www/data/readme.json |
15 | cd www && hugo -d ../docs |
16 | |
17 | diff --git a/README.md b/README.md |
18 | index 2332996..5aa4e3e 100644 |
19 | --- a/README.md |
20 | +++ b/README.md |
21 | @@ -49,7 +49,7 @@ pomo start -t my-project "write some codes" |
22 | |
23 | ## Configuration |
24 | |
25 | - Pomo has a few configuration options which can be read from a JSON file in Pomo's state directory `~/.pomo/config.json`. |
26 | + Pomo has a few configuration options which can be read from a JSON file in Pomo's config directory `~/.config/pomo/config.json`. |
27 | |
28 | ### colors |
29 | |
30 | diff --git a/man/pomo.1 b/man/pomo.1 |
31 | new file mode 100644 |
32 | index 0000000..4031e77 |
33 | --- /dev/null |
34 | +++ b/man/pomo.1 |
35 | @@ -0,0 +1,89 @@ |
36 | + .\" Generated by scdoc 1.11.2 |
37 | + .\" Complete documentation for this program is not available as a GNU info page |
38 | + .ie \n(.g .ds Aq \(aq |
39 | + .el .ds Aq ' |
40 | + .nh |
41 | + .ad l |
42 | + .\" Begin generated content: |
43 | + .TH "pomo" "1" "2022-05-30" |
44 | + .P |
45 | + .SH NAME |
46 | + .P |
47 | + \fBPomo\fR is a simple CLI for using the Pomodoro Technique.\& |
48 | + .P |
49 | + .SH SYNOPSIS |
50 | + .P |
51 | + \fBpomo\fR [OPTIONS] COMMAND [arg.\&.\&.\&] |
52 | + .P |
53 | + .SH DESCRIPTION |
54 | + .P |
55 | + \fBpomo\fR helps you track what you did, how long it took you to do it, |
56 | + and how much effort you expect it to take.\& |
57 | + .P |
58 | + The Pomodoro Technique is simple and effective: |
59 | + .P |
60 | + .RS 4 |
61 | + \fB\fR Decide on a task you want to accomplish |
62 | + \fB\fR Break the task into timed intervals (pomodoros), [approx.\& 25 min] |
63 | + \fB\fR After each pomodoro take a short break [approx.\& 3 - 5 min] |
64 | + \fB\fR Once all pomodoros are completed take a longer break [approx 15 - 20 min] |
65 | + \fB\fR Repeat |
66 | + .P |
67 | + .RE |
68 | + .SH SUBCOMMANDS |
69 | + .P |
70 | + See --help for the complete command usage |
71 | + .P |
72 | + .nf |
73 | + .RS 4 |
74 | + start, s start a new task |
75 | + init initialize the sqlite database |
76 | + config, cf display the current configuration |
77 | + create, c create a new task without starting |
78 | + begin, b begin requested pomodoro |
79 | + list, l list historical tasks |
80 | + delete, d delete a stored task |
81 | + status, st output the current status |
82 | + |
83 | + .fi |
84 | + .RE |
85 | + .P |
86 | + .SH CONFIGURATION |
87 | + .P |
88 | + Pomo has a configuration file that is stored in \fB~/.\&config/pomo/config.\&json\fR.\& |
89 | + .P |
90 | + .nf |
91 | + .RS 4 |
92 | + { |
93 | + "colors": null, |
94 | + "dateTimeFmt": "2006-01-02 15:04", |
95 | + "publish": false, |
96 | + "publishJson": false, |
97 | + "publishSocketPath": "" |
98 | + } |
99 | + .fi |
100 | + .RE |
101 | + .P |
102 | + .SH EXAMPLES |
103 | + .P |
104 | + .SS GETTING STARTED |
105 | + .P |
106 | + .nf |
107 | + .RS 4 |
108 | + # ensure your database has been initialized |
109 | + pomo init |
110 | + # run a new pomodoro |
111 | + pomo start -t my-project "write some code" |
112 | + # once finished view previously completed pomodoros |
113 | + pomo list |
114 | + .fi |
115 | + .RE |
116 | + .P |
117 | + .SH SEE ALSO |
118 | + .P |
119 | + See the pomo source repository on Github at https://github.\&com/kevinschoon/pomo for complete documentation.\& |
120 | + .P |
121 | + .SH AUTHORS |
122 | + .P |
123 | + Written by Kevin Schoon <me@kevinschoon.\&com> with help from the open source |
124 | + community.\& |
125 | diff --git a/man/pomo.1.scd b/man/pomo.1.scd |
126 | new file mode 100644 |
127 | index 0000000..4dbe9c9 |
128 | --- /dev/null |
129 | +++ b/man/pomo.1.scd |
130 | @@ -0,0 +1,74 @@ |
131 | + pomo(1) |
132 | + |
133 | + # NAME |
134 | + |
135 | + *Pomo* is a simple CLI for using the Pomodoro Technique. |
136 | + |
137 | + # SYNOPSIS |
138 | + |
139 | + *pomo* [OPTIONS] COMMAND [arg...] |
140 | + |
141 | + # DESCRIPTION |
142 | + |
143 | + *pomo* helps you track what you did, how long it took you to do it, |
144 | + and how much effort you expect it to take. |
145 | + |
146 | + The Pomodoro Technique is simple and effective: |
147 | + |
148 | + ** Decide on a task you want to accomplish |
149 | + ** Break the task into timed intervals (pomodoros), [approx. 25 min] |
150 | + ** After each pomodoro take a short break [approx. 3 - 5 min] |
151 | + ** Once all pomodoros are completed take a longer break [approx 15 - 20 min] |
152 | + ** Repeat |
153 | + |
154 | + # SUBCOMMANDS |
155 | + |
156 | + See --help for the complete command usage |
157 | + |
158 | + ``` |
159 | + start, s start a new task |
160 | + init initialize the sqlite database |
161 | + config, cf display the current configuration |
162 | + create, c create a new task without starting |
163 | + begin, b begin requested pomodoro |
164 | + list, l list historical tasks |
165 | + delete, d delete a stored task |
166 | + status, st output the current status |
167 | + |
168 | + ``` |
169 | + |
170 | + # CONFIGURATION |
171 | + |
172 | + Pomo has a configuration file that is stored in *~/.config/pomo/config.json*. |
173 | + |
174 | + ``` |
175 | + { |
176 | + "colors": null, |
177 | + "dateTimeFmt": "2006-01-02 15:04", |
178 | + "publish": false, |
179 | + "publishJson": false, |
180 | + "publishSocketPath": "" |
181 | + } |
182 | + ``` |
183 | + |
184 | + # EXAMPLES |
185 | + |
186 | + ## GETTING STARTED |
187 | + |
188 | + ``` |
189 | + # ensure your database has been initialized |
190 | + pomo init |
191 | + # run a new pomodoro |
192 | + pomo start -t my-project "write some code" |
193 | + # once finished view previously completed pomodoros |
194 | + pomo list |
195 | + ``` |
196 | + |
197 | + # SEE ALSO |
198 | + |
199 | + See the pomo source repository on Github at https://github.com/kevinschoon/pomo for complete documentation. |
200 | + |
201 | + # AUTHORS |
202 | + |
203 | + Written by Kevin Schoon <me@kevinschoon.com> with help from the open source |
204 | + community. |