78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
<p align="center"><img src="https://raw.githubusercontent.com/kevinschoon/pomo/master/www/static/demo.gif" alt="demo"/></p>
|
|
|
|
# 🍅 pomo
|
|
|
|
`pomo` is a simple CLI for using the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). There are [some](https://taskwarrior.org/) [amazing](https://todoist.com/) task management systems but `pomo` is more of a task *execution* or [timeboxing](https://en.wikipedia.org/wiki/Timeboxing) system. `pomo` helps you track what you did, how long it took you do it, and how much effort you expect it to take.
|
|
|
|
## Background
|
|
|
|
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
|
|
|
|
## Installation
|
|
|
|
### Binaries
|
|
|
|
Binaries are available for Linux and Darwin platforms in the [releases section](https://github.com/kevinschoon/pomo/releases) on github.
|
|
|
|
#### Linux
|
|
|
|
```
|
|
curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-linux-amd64
|
|
# Optionally verify file integrity
|
|
echo 2543baef75c58c01a246e8d79ac59c93 pomo | md5sum -c -
|
|
chmod +x pomo
|
|
./pomo -v
|
|
# Copy pomo to somewhere on your $PATH
|
|
```
|
|
|
|
#### Darwin
|
|
|
|
```
|
|
curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-darwin-amd64
|
|
# Optionally verify file integrity
|
|
[[ $(md5 -r pomo) != "7d5217f0e8f792f469a20ae86d4c35c2 pomo" ]] && echo "invalid hash!"
|
|
chmod +x pomo
|
|
./pomo -v
|
|
# Copy pomo to somewhere on your $PATH
|
|
|
|
```
|
|
|
|
### Source
|
|
|
|
```
|
|
go get github.com/kevinschoon/pomo
|
|
pomo -v
|
|
```
|
|
|
|
## Usage
|
|
|
|
Once `pomo` is installed you need to initialize it's database.
|
|
|
|
```
|
|
pomo init
|
|
```
|
|
|
|
Start a 4 pomodoro session at 25 minute intervals:
|
|
```
|
|
pomo start -t my-project "write some codes"
|
|
```
|
|
|
|
## Roadmap
|
|
|
|
* Generate charts/burn down
|
|
* System tray notification/icon
|
|
* ??
|
|
|
|
## Credits
|
|
|
|
* [pomodoro technique](https://cirillocompany.de/pages/pomodoro-technique/book/)
|
|
* [logo by rones](https://openclipart.org/detail/262421/tomato-by-rones)
|
|
* [website generate by hugo](http://gohugo.io/)
|
|
* [theme by calintat](https://github.com/calintat/minimal)
|