https://github.com/marcinkoziej/org-pomodoro

pomodoro technique for org-mode
https://github.com/marcinkoziej/org-pomodoro

Last synced: 5 days ago
JSON representation

pomodoro technique for org-mode

• Host: GitHub
• URL: https://github.com/marcinkoziej/org-pomodoro
• Owner: marcinkoziej
• License: gpl-3.0
• Created: 2011-07-13T18:25:40.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2023-11-04T17:00:46.000Z (about 1 year ago)
• Last Synced: 2024-02-16T07:36:35.077Z (9 months ago)
• Language: Emacs Lisp
• Homepage: https://github.com/lolownia/org-pomodoro
• Size: 194 KB
• Stars: 576
• Watchers: 18
• Forks: 77
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
[![MELPA Stable](http://stable.melpa.org/packages/org-pomodoro-badge.svg)](http://stable.melpa.org/#/org-pomodoro)

[![MELPA](http://melpa.org/packages/org-pomodoro-badge.svg)](http://melpa.org/#/org-pomodoro)

Org-Pomodoro

============

This adds very basic support for

[Pomodoro technique](http://www.pomodorotechnique.com/)

in Emacs' org-mode.

With default options:

You can start a pomodoro for the task at point or select one of the

last tasks that you clocked time for. Each clocked-in pomodoro

starts a timer of 25 minutes and after each pomodoro a break timer of

5 minutes is started automatically. Every 4 breaks a long break is

started with 20 minutes. All values are customizable.

Installation

============

 Install from MELPA:

 * Add MELPA to your EMACS installation:

         (add-to-list 'package-archives

                      '("melpa" . "https://melpa.org/packages/") t)

 * Install the package via `M-x package-install RET org-pomodoro`

Usage

=====

 1. Move point to a task as you would do with `org-clock-in`.

    Call `org-pomodoro` the task will be clocked-in.

 2. When there's time for break, the task will be `org-clock-out`'ed

 3. If you call `org-pomodoro` during a pomodoro, you'll be asked to reset

    a pomodoro.

 4. If you call `org-pomodoro` outside org-mode, you'll be presented

    with list of recent tasks, as `C-u org-clock-in` would.

Customization

=============

Most aspects of `org-pomodoro` can be customized. Examples are the

length of pomodoros and breaks (`org-pomodoro-length`,

`org-pomodoro-short-break-length`, `org-pomodoro-long-break-length`),

sounds, modeline display, if breaks should be clocked

(`org-pomodoro-clock-break`) the behaviour when a pomodoro is reset

(`org-pomodoro-ask-upon-killing`, `org-pomodoro-keep-killed-time`)

etc. Have a look at the `org-pomodoro` customization group.

Some workflows benefit from the option to work a few minutes

“overtime” to finish a task before taking a break (that is, a slightly

dynamic pomodoro time). The option `org-pomodoro-manual-break` enables

this workflow, where a break notification is sent at the end of the

pomodoro time but the break is started first when manually calling

`org-pomodoro`.

License

=======

This file is free software; you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 3, or (at your option)

any later version.

This file is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with GNU Emacs; see the file COPYING.  If not, write to

the Free Software Foundation, Inc., 59 Temple Place - Suite 330,

Boston, MA 02111-1307, USA.