Skip to content

Commit e6ec3cb

Browse files
committed
doc: rework README.md
1 parent cef98ef commit e6ec3cb

3 files changed

Lines changed: 15 additions & 18 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,19 @@
99

1010
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1111
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
12-
1312
## Table of contents
1413

1514
- [Screenshots](#screenshots)
16-
- [Timer](#timer)
17-
- [Settings](#settings)
1815
- [Features](#features)
1916
- [Changelog](#changelog)
17+
- [Usage](#usage)
2018
- [Configuration](#configuration)
21-
- [Notification sound](#notification-sound)
19+
- [Start minimized](#start-minimized)
20+
- [Change notification sound](#change-notification-sound)
2221
- [Install](#install)
23-
- [Install Ubuntu/Debian (.deb)](#install-ubuntudebian-deb)
24-
- [Install Fedora/Redhat (.rpm)](#install-fedoraredhat-rpm)
25-
- [Download Linux binaries](#download-linux-binaries)
22+
- [Install Ubuntu/Debian (.deb)](#install-ubuntudebian-deb)
23+
- [Install Fedora/Redhat (.rpm)](#install-fedoraredhat-rpm)
24+
- [Download Linux binaries](#download-linux-binaries)
2625
- [Releasing the project](#releasing-the-project)
2726
- [TODO & IDEAS](#todo--ideas)
2827
- [Credits](#credits)
@@ -31,31 +30,27 @@
3130

3231
## Screenshots
3332

34-
### Timer
35-
3633
<p align="center" width="100%">
37-
<img src="screenshots/app.pimped.png" alt="Fynodoro app screenshot">
38-
</p>
39-
40-
### Settings
41-
42-
<p align="center" width="100%">
43-
<img src="screenshots/settings.pimped.png" alt="Fynodoro settings screenshot">
34+
<img src="screenshots/app.pimped.png" alt="Fynodoro app screenshot"/>
4435
</p>
4536

4637
## Features
4738

4839
- ⏲️ Pomodoro Timer ✨
4940
- πŸ—’οΈ Configurable: work duration, short break/long break, work rounds πŸ–ŠοΈ
5041
- πŸ† Small download size
51-
- πŸ’Ό Releases for Ubuntu/Debian, Fedora/Redhat, and as linux binary
42+
- πŸ’Ό Releases for Ubuntu/Debian, Fedora/Redhat, and as a linux binary
5243

5344
## Changelog
5445

5546
See the [Releases](https://github.com/tomsquest/fynodoro/releases) section on GitHub.
5647

5748
## Usage
5849

50+
A `.desktop` file is installed for you, so you can start Fynodoro from your application menu.
51+
52+
You can also start it from the command line:
53+
5954
```shell
6055
fynodoro # Start normally
6156
fynodoro --minimized # Start minimized to system tray
@@ -78,9 +73,11 @@ You can **disable** Short breaks by setting the duration of Short breaks to `0`.
7873

7974
Tips: you can **disable** both Short and Long breaks by setting them to `0`. The timer will then act as a ticker, notifying you after each Work period.
8075

76+
### Start minimized
77+
8178
You can **start minimized** to the system tray by enabling the option in Settings, or by using the `--minimized` command-line flag.
8279

83-
### Notification sound
80+
### Change notification sound
8481

8582
The notification sound is stored in: `/usr/share/fynodoro/notification.mp3`.
8683
You can override it if you wish with another **mp3** file.
-87.9 KB
Binary file not shown.

β€Žscreenshots/settings.pngβ€Ž

-34.3 KB
Binary file not shown.

0 commit comments

Comments
Β (0)