locking-pomodoro-timer 1.1.0

A Pomodoro timer with the capability of locking the screen.
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->

<a name="readme-top" id="readme-top"></a>
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Don't forget to give the project a star!
*** Thanks again! Now go create something AMAZING! :D
-->




<!-- PROJECT SHIELDS -->

<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url]



<!-- PROJECT LOGO -->

<br />
<div align="center">
  <a href="https://github.com/davidzanger/Locking-Pomodoro-Timer">
    <img src="assets/pomodoro.webp" alt="Logo" width="80" height="80">
  </a>

<h3 align="center">Locking Pomodoro Timer</h3>

  <p align="center">
    A Pomodoro timer with the capability of locking the screen.
    <br />
    <a href="https://docs.rs/crate/locking-pomodoro-timer/latest"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/davidzanger/Locking-Pomodoro-Timer/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
    ·
    <a href="https://github.com/davidzanger/Locking-Pomodoro-Timer/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
  </p>
</div>



<!-- TABLE OF CONTENTS -->

<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project


![Pomodoro Screen Shot](assets/pomodoro_sample.png)

There are many Pomodoro timers available on the web, however, I couldn't find one that would lock the screen. I wanted to create a simple Pomodoro timer that would lock the screen after a certain amount of time as just a sound notification wasn't enough to really stop me working.
The [Pomodoro technique](https://en.wikipedia.org/wiki/Pomodoro_Technique) is a time management method that uses a timer to break down work into intervals, traditionally 25 minutes in length, separated by short breaks. This technique is used to improve focus and productivity.

### Built With


[![Rust][Rust]][Rust-url]

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->

## Getting Started


### Download Executable


The easiest way to use the Pomodoro timer is to download the executable from the [releases](https://github.com/davidzanger/Locking-Pomodoro-Timer/releases) page and run it on your machine.
If you want to build the project yourself, follow the instructions below.

### Prerequisites


Install Rust by following the instructions on the [Rust website](https://www.rust-lang.org/tools/install).

### Installation


1. Clone the repo

   ```sh
   git clone https://github.com/davidzanger/Locking-Pomodoro-Timer.git

   ```

2. Build the project

   ```sh
   cargo build --release

   ```

3. Use the executable which can be found in the `target/release` directory.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->

## Usage


To use the Pomodoro timer, simply run the executable. On the first run, the program will create a `.json` file next to the executable which will store the settings for the timer. The settings can be changed by editing the `.json` file.

The default settings are as follows:

```json	
{
    // The duration of a single Pomodoro session in minutes.
    "durationPomodoro": 25,
    // The additional duration in minutes to be added to a Pomodoro session when it is over.
    "additionalDuration": 5,
    // The duration of a short break in minutes.
    "durationShortBreak": 5,
    // The duration of a long break in minutes.
    "durationLongBreak": 15,
    // Flag indicating whether to automatically start a break after a Pomodoro session ends.
    "autoStartBreak": true,
    // Flag indicating whether to automatically start a new Pomodoro session after a break ends.
    "autoStartPomodoro": true,
    // The interval in number of Pomodoro sessions after which a long break should be taken.
    "intervalLongBreak": 4,
    // The end event to be executed after a Pomodoro session ends.
    "endEventPomodoro": {
        "sound": {
            "filepathSound": ""
        }
    },
    // The end event to be executed after the additional Pomodoro after a Pomodoro session ends.
    "endEventAdditionalPomodoro": "lockScreen"
}
```

For the `endEventPomodoro` and `endEventAdditionalPomodoro` fields, the following options are available:

- `sound`: Play a sound file. The path to the sound file must be provided in the `filepathSound` field. If the path is empty, the default sound will be played.
- `lockScreen`: Lock the screen. This feature is currently only available on Windows.

_For more details, please refer to the [Documentation](https://docs.rs/crate/locking-pomodoro-timer/latest)_

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ROADMAP -->

## Roadmap


- [ ] Create a GUI for the timer.

See the [open issues](https://github.com/davidzanger/Locking-Pomodoro-Timer/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- CONTRIBUTING -->

## Contributing


Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- LICENSE -->

## License


Distributed under the GPL-3.0 License. See `LICENSE` for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTACT -->

## Contact


Project Link: [https://github.com/davidzanger/Locking-Pomodoro-Timer](https://github.com/davidzanger/Locking-Pomodoro-Timer)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- MARKDOWN LINKS & IMAGES -->

<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/davidzanger/Locking-Pomodoro-Timer.svg?style=for-the-badge
[contributors-url]: https://github.com/davidzanger/Locking-Pomodoro-Timer/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/davidzanger/Locking-Pomodoro-Timer.svg?style=for-the-badge
[forks-url]: https://github.com/davidzanger/Locking-Pomodoro-Timer/network/members
[stars-shield]: https://img.shields.io/github/stars/davidzanger/Locking-Pomodoro-Timer.svg?style=for-the-badge
[stars-url]: https://github.com/davidzanger/Locking-Pomodoro-Timer/stargazers
[issues-shield]: https://img.shields.io/github/issues/davidzanger/Locking-Pomodoro-Timer.svg?style=for-the-badge
[issues-url]: https://github.com/davidzanger/Locking-Pomodoro-Timer/issues
[license-shield]: https://img.shields.io/github/license/davidzanger/Locking-Pomodoro-Timer.svg?style=for-the-badge
[license-url]: https://github.com/davidzanger/Locking-Pomodoro-Timer/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/david-zanger-8a4340137
[Rust]: https://img.shields.io/badge/Rust-000000?style=for-the-badge&logo=rust&logoColor=white
[Rust-url]: https://www.rust-lang.org/