barak/tpm
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

More readme cleanup

Browse source
This commit is contained in:
Barak Michener 2013-09-01 16:19:41 -04:00
parent f5eb6e2d4b
commit dd8822413a
1 changed files with 14 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,7 +1,7 @@
# TiddlyPom # TiddlyPom
## _A simple console Pomodoro for C++ neckbeards_ ## _A simple console Pomodoro for C++ neckbeards_
##### Why? ### Why?
I wanted a simple, UNIX-friendly [Pomodoro](http://pomodorotechnique.com/) timer. I wanted a simple, UNIX-friendly [Pomodoro](http://pomodorotechnique.com/) timer.
So I came across [Thyme](http://thymerb.com) and, while simple, it requires (a) a whole Ruby stack, (b) a bunch of dependencies and (c) does the annoying thing of writing to a file for integration elsewhere. A cute trick, but a dirty one nonetheless. So I came across [Thyme](http://thymerb.com) and, while simple, it requires (a) a whole Ruby stack, (b) a bunch of dependencies and (c) does the annoying thing of writing to a file for integration elsewhere. A cute trick, but a dirty one nonetheless.
@ -10,15 +10,16 @@ There's a right way to do this. UNIX domain sockets! C++!
So here it is. So here it is.
#### Building ### Building
Clone the repository. In the directory, run Clone the repository. In the directory, run
``` ```
make make
``` ```
And assuming you have g++ and a unixy system, it will just work. Nothing special. And assuming you have g++ and a unixy system, it will just work. Nothing special.
#### Usage ### Usage
If you try If you try
``` ```
@ -46,22 +47,26 @@ For 90 seconds or 15 minutes, respectively. Now that it's running, run
And lo, the remaining time will be echoed back to you. And lo, the remaining time will be echoed back to you.
#### Integration ### Integration
Because just running tpom is sufficient to connect to the daemon and get the remaining time (without smashing your filesystem cache) -- running the command means you can integrate it wherever you need. Because just running tpom is sufficient to connect to the daemon and get the remaining time (without smashing your filesystem cache) -- running the command means you can integrate it wherever you need.
##### tmux #### tmux
Add Add
``` ```
set -g status-right '#(~/path/to/tpom/tpom)' set -g status-right '#(~/path/to/tpom/tpom)'
set -g status-interval 1 set -g status-interval 1
``` ```
Potentially with other options for your status-right, potentially other colors -- mine, for instance is: Potentially with other options for your status-right, potentially other colors -- mine, for instance is:
``` ```
set -g status-right '#[fg=green]#(~/src/tpom/tpom) #[fg=cyan,bold]%Y-%m-%d %H:%M:%S#[default]' set -g status-right '#[fg=green]#(~/src/tpom/tpom) #[fg=cyan,bold]%Y-%m-%d %H:%M:%S#[default]'
``` ```
But you can fit it to taste. But you can fit it to taste.
##### awesome #### awesome
I love [AwesomeWM](http://awesome.naquadah.org/). So you can add the timer as a countdown widget in your ~/.config/awesome/rc.lua: I love [AwesomeWM](http://awesome.naquadah.org/). So you can add the timer as a countdown widget in your ~/.config/awesome/rc.lua:
``` ```
@ -76,9 +81,9 @@ pomtimer:start()
And add the ```pom``` variable to your widgets list. And add the ```pom``` variable to your widgets list.
#### Post-Hook ### Post-Hook
Not to be outdone, you can execute an arbitrary script when the timer goes off. This is totally useful to cause notifications to fly, ring an alarm -- whatever you like. Create an executable file at ```~/.tpm-post.sh```` with a standard ```#!``` line at the top. An example is included -- just copy it to the right place. Not to be outdone, you can execute an arbitrary script when the timer goes off. This is totally useful to cause notifications to fly, ring an alarm -- whatever you like. Create an executable file at ```~/.tpm-post.sh``` with a standard ```#!``` line at the top. An example is included -- just copy it to the right place.
#### Questions? ### Questions?
It's a tiny thing, but feel free to help me improve it. Drop me a line, or [follow me on Twitter](http://twitter.com/barakmich). It's a tiny thing, but feel free to help me improve it. Drop me a line, or [follow me on Twitter](http://twitter.com/barakmich).