File: README.md

package info (click to toggle)
redtick 00.01.02%2Bgit20170220.e6d2e9b%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 672 kB
  • sloc: lisp: 202; makefile: 2
file content (42 lines) | stat: -rw-r--r-- 1,875 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
RedTick
=======

## What

This package provides a little pomodoro timer in the mode-line.

![Redtick](redtick.gif)

## How

* Use `(require 'redtick)`. After requiring, it shows a little red tick (✓) in the mode-line. When
you click on it, it starts a pomodoro timer. The pomodoro description is set using current-buffer and which-function.
![Redtick description](redtick-description.png)

* You can launch a pomodoro by M-x redtick, or M-x redtick-with-description (manual description).

It only shows the timer in the selected window (a moving timer
replicated in each window is a little bit distracting!).

## Why

I thought about this, after seeing the [spinner.el package](https://github.com/Malabarba/spinner.el).

## Elisp

I tried to make it efficient:
  - It uses an elisp timer to program the next modification of the
    pomodoro timer.
  - Only works when the mode-line is changed.

## Thanks to

* Malabarba, for the spinner and smart-mode-line packages.
* abo-abo, for asking how to check if the current window is selected from
inside the mode-line, and Drew for answering it.
* purcell at melpa, for reviewing the code. 
* wellons at nullprogram.com, for the code used to save and restore lisp data.
* Alexani, for the sound of a [pocketwatch ticking](https://www.freesound.org/people/Alexsani/sounds/117280/) found at 'freesound.org'.
* unfa, for the sound of a [clock making a perfect 10-second loop](https://www.freesound.org/people/unfa/sounds/154906/) (cut to make a 2-second loop) found at 'freesound.org'.
* Jeremy Seitz, for the *fantastic* :notes: sounds that he created with a Nord Modular synthesizer, [published in 2007 in his blog](http://www.fozworks.com/blog/2007/07/28/autotest-sound-effects/), and that I've been using since then when autotesting in Ruby.
* [Carlo Zancanaro](https://github.com/czan) for cleaning the main loop using hooks.