Permalink
Browse files

Update document for pomodoro-mode

  • Loading branch information...
syohex committed Mar 30, 2013
1 parent e860d92 commit 044b742bc1f3bd8eabe7d864df9dbd6b6f96e392
Showing with 48 additions and 3 deletions.
  1. +45 −0 README.md
  2. +3 −3 pomodoro.el
View
@@ -6,6 +6,51 @@
(Pomodoro Technique)[http://www.pomodorotechnique.com/] in Emacs.
This is my own implementation.
+### Customize
+
+#### pomodoro:file
+
+Open file when a pomodoro is finished.
+No file is opened if `pomodoro:file` is `non-nil`.
+
+#### pomodoro:work-time(Default: 25)
+
+Minutes of work periodo.
+
+#### pomodoro:reset-time(Default: 5)
+
+Minutes of short rest period.
+
+#### pomodoro:long-rest-time(Default: 30)
+
+Minutes of long rest period.
+
+#### pomodoro:iteration-for-long-rest
+
+Iteration count when switching to long rest
+
+#### Faces and Signed
+
+Default value of all signs are "●".
+
+| | sign | face |
+|:-------------|:----------------------------------|:------------------------|
+| Work | pomodoro:mode-line-work-sign | pomodoro:work-face |
+| Short Rest | pomodoro:mode-line-rest-sign | pomodoro:rest-face |
+| Long Rest | pomodoro:mode-line-long-rest-sign | pomodoro:long-rest-face |
+
+
+#### hooks
+
+`pomodoro.el` has some hooks, they are called after work, short rest,
+long rest.
+
+| | hook | Description |
+|:-------------|:--------------------------|:-------------------------------|
+| Work | pomodoro:finish-work-hook | Called after work period |
+| Short Rest | pomodoro:finish-rest-hook | Called after short rest period |
+| Long Rest | pomodoro:long-rest-hook | Called after long rest period |
+
### Related Projects
View
@@ -29,17 +29,17 @@
:type 'string)
(defcustom pomodoro:work-time 25
- "Work minitus"
+ "Minutes of work period"
:group 'pomodoro
:type 'integer)
(defcustom pomodoro:rest-time 5
- "Rest minutes"
+ "Minutes of rest period"
:group 'pomodoro
:type 'integer)
(defcustom pomodoro:long-rest-time 30
- "Rest minutes"
+ "Minutes of long rest period"
:group 'pomodoro
:type 'integer)

0 comments on commit 044b742

Please sign in to comment.