https://github.com/weakish/pomodoro-timer
a simple command line pomodoro timer
https://github.com/weakish/pomodoro-timer
Last synced: about 1 year ago
JSON representation
a simple command line pomodoro timer
- Host: GitHub
- URL: https://github.com/weakish/pomodoro-timer
- Owner: weakish
- License: other
- Created: 2013-11-09T11:22:20.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2016-04-20T14:40:43.000Z (about 10 years ago)
- Last Synced: 2025-04-08T17:07:29.787Z (about 1 year ago)
- Language: Shell
- Size: 183 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
pomodoro-timer
==============
A simple pomodoro timer.
Depends
-------
- libnotify
- vorbis-tools
- at
- wget
Install
-------
### With basher
```sh
; basher install weakish/pomodoro-timer
```
Require [basher][] version: `>=39875bc`.
[basher]: https://github.com/basherpm/basher
### With rake
rake install
The script will be installed into `/usr/bin/`.
If you want to install to other place, use a `prefix`, e.g.
rake "install[/usr/local]"
### Manually
If you don't want to use basher or rake,
you can just copy `pomodoro-timer.sh` to any directory in your PATH.
Usage
-----
pomodoro-timer
By default, a pomodoro takes 25 minutes.
Prefer a short pomodoro? No problem!
pomodoro-timer 15
Want to destroy the current pomodoro?
pomodoro-timer destroy
Ring file
---------
Ring file is located at `~/.config/pomodoro-timer/bell.ogg`.
You can replace it with your own ring file,
as long as your ring file is Ogg Vorbis audio file.
Test
------
### With rake
```sh
; rake test
```
### Manually
```sh
; cd test
; bats pomodoro-timer.bats
```
Do not forget to run atq and atrm after tests.
Otherwise, there will be a lot of notifications!
Pomodoro technique
------------------
The Pomodoro Technique is a time management method developed by Francesco Cirillo in the late 1980s.
The technique uses a timer to break down periods of work into 25-minute intervals called "pomodori" (from the Italian word pomodoro for "tomato"), separated by short breaks.
For more information, have a look at [its wikipedia page](https://en.wikipedia.org/wiki/Pomodoro_Technique).
License
---------
0BSD