Merge branch 'master' of github.com:kevinschoon/pomo

This commit is contained in:
Kevin Schoon 2018-01-22 18:46:24 +08:00
commit 6c8ffe602a
1 changed files with 53 additions and 2 deletions

View File

@ -1,3 +1,54 @@
# pomo
# 🍅 pomo
`pomo` is a simple CLI implementation of the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). It integrates with [i3](i3wm.org) and might support other environments later on.
`pomo` is a simple CLI implementation of the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). It was written for use on a Linux desktop but can easily be ported over to other platforms.
## Background
The Pomodoro Technique is simple and effective time management technique:
* 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
## Installation
### Binaries
Check out the [releases section](https://github.com/kevinschoon/pomo/releases) for the latest binrary.
### Source
```
go get github.com/kevinschoon/pomo
cd $GOPATH/github.com/kevinschoon/pomo
make
./bin/pomo
```
## Usage
```
# Initialize the SQLite database and state directory
pomo init
# Start a new task
# Add a tag "dev", allocate 2 pomodoros for 1 minute each
pomo start -t dev -p 2 -d 1m "Write Some Codes"
...
# List previous tasks
# pomo list
...
```
## Dependencies
`pomo` depends on the [libnotify](https://developer.gnome.org/libnotify/) client package, a notification [server](https://wiki.archlinux.org/index.php/Desktop_notifications#Notification_servers) (installed with most Linux desktop environments), and [SQLite](https://sqlite.org/).
## Roadmap
* Support OSX
* Support Windows
* Generate charts
* Alternate notifiers
* ??