From dd8822413ab10f221450806a42743800e6aa6488 Mon Sep 17 00:00:00 2001 From: Barak Michener Date: Sun, 1 Sep 2013 16:19:41 -0400 Subject: [PATCH] More readme cleanup --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index aa250a0..97342d4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # TiddlyPom ## _A simple console Pomodoro for C++ neckbeards_ -##### Why? +### Why? 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. @@ -10,15 +10,16 @@ There's a right way to do this. UNIX domain sockets! C++! So here it is. -#### Building +### Building Clone the repository. In the directory, run + ``` make ``` And assuming you have g++ and a unixy system, it will just work. Nothing special. -#### Usage +### Usage 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. -#### 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. -##### tmux +#### tmux Add + ``` set -g status-right '#(~/path/to/tpom/tpom)' set -g status-interval 1 ``` + 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]' ``` + 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: ``` @@ -76,9 +81,9 @@ pomtimer:start() 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).