Skip to content

Commit

Permalink
DOC Include font instructions in the main README
Browse files Browse the repository at this point in the history
  • Loading branch information
unode committed Jan 28, 2021
1 parent ccffecb commit 5978abb
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ click-right = /path/to/polypomo end
click-middle = /path/to/polypomo lock
scroll-up = /path/to/polypomo time +60
scroll-down = /path/to/polypomo time -60
font-0 = fixed:pixelsize=10;1
font-1 = Noto Emoji:scale=15:antialias=false;0
```

In order to prevent accidental changes to the timer, polypomo starts in `locked` mode.
Expand All @@ -29,6 +32,12 @@ You can then scroll-up/down to change time.

If you wish to permanently change the default times start polypomo with `--worktime seconds` and `--breaktime seconds`.

### Fonts

In order to display the icons as shown in the screenshots below,
you need to configure a font that includes the Unicode glyphs U+1F345 (🍅) and U+1F3D6 (🏖).
The example above uses the font [Noto Emoji](https://www.google.com/get/noto/help/emoji/).

### About pomodoro technique

While polypomo implements the `active -> break -> active` pattern it doesn't enforce the longer break after a given number of active sprees.
Expand Down

0 comments on commit 5978abb

Please sign in to comment.