personal/pomo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README with timer description

Browse Source
This commit is contained in:
Ivan Tham 2020-06-15 00:38:39 +08:00
parent 783e2d8f95
commit de7a76f87f
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -3,14 +3,12 @@ spt - simple pomodoro timer
spt is a simple timer that uses the pomodoro technique that doubles your spt is a simple timer that uses the pomodoro technique that doubles your
efficiency. efficiency.
Features Features
-------- --------
- Get the jobs done quicker than ever - Get the jobs done quicker than ever
- Keeps you free like a dog - Keeps you free like a dog
- Able to show remaining time - Able to show remaining time
Installation Installation
------------ ------------
Edit config.mk to match your local setup (spt is installed into the /usr/local Edit config.mk to match your local setup (spt is installed into the /usr/local
@ -23,12 +21,12 @@ as root):
See the man pages for additional details. See the man pages for additional details.
Configuration Configuration
------------- -------------
The configuration of spt is done by creating a custom config.h The configuration of spt is done by creating a custom config.h and
and (re)compiling the source code. (re)compiling the source code. By default, the timer runs by 4
pomodoro timer (25 mins) with subsequent rests in between (15 mins)
followed by a long rest (5 mins) in an infinite loop.
Links Links
----- -----