<commit_before>[Versión en español](README_es.md)

# Introduction

On the daily use of the *Pomodoro Technique (R)*, I prefer to use a pencil and a diary for the task tracking. Handwriting all of that allows to be more concious of the pending things to do.

So, were looking for a simple timer for this technique, including some features that are boring to do with pencil and paper, like record diary statistics of finished pomodoris and interruptions and not much more.

Most of the better software tools found for this technique available, includes functionality that makes the UI more complex or distractive, like TO-DO lists, tasks categories and lots of options I do not want to be present there. Or, in the other extreme, are just too simple.

As couldn't find what I needed, implemented this one.



# Download

Checkout the most recent release [here](https://github.com/mmazzei/Pomodorin/releases).



# Usage

The UI target is to be simple and clear. If you allways click at the big image at the center, it will do what you need most of the time.


## How to start a new pomodori?

You can click on the big tomato button:

  ![Main view](readmeAssets/mainScreen.png)

If you just finished a break, the following window will be shown:

![Deciding next step](readmeAssets/decideWhatIsNext_tomato.png)

That could be different, depending on your current session, because Pomodorin will recommend you the next step, making that button bigger than the alternatives. So, if you just finished a pomodori, that window will look like:

![Deciding next step](readmeAssets/decideWhatIsNext_shortBreak.png)

It doesn't matter if small or big, the tomato button start a pomodori.


## How to start a break?

Just by clicking on the hourglass buttons.

Short break:
![Short break](readmeAssets/half_hourglass.png)

Long break:
![Long break](readmeAssets/full_hourglass.png)


## How to stop a pomodori or break?

The small "-" button at the bottom of the screen is what you want.


## How to automatically start pomodoris and breaks?

There are an *experimental* feature to do so: **Auto-mode**.

When Pomodorin is running in Auto-mode, automatically will start the next pomodori, short break or long break, depending on your previous actions.

You can activate that by clicking the small lock icon at the bottom of the screen.

If you close the Pomodorin application, the next pomodori or break will not be automatically started until you open it again.


# FAQ

## What is the meaning of the version name?

"A mi me anda" is a common software developer excuse. The meaning in english is: "It works for me".

If you are a programmer and need some ideas for your excuses, there are a nice site can be helpful for you: [programmingexcuses.com](http://programmingexcuses.com).

If you are not a programmer, do as if you never read this part. We do not invent excuses, that phrases are true comments from the soul!


## Why this page, the code and the UI are so bad written?

English is not my main language (good excuse!). Hope to have a collaborator to improve this in order to remove this question from here.


## How do you do to have a FAQ if there are no users yet?

Ok, I invented the questions to fill some space here.

Was about that or sit and write the next awesome Pomodorin feature.


## Why the Pomodorin application is so bad?

Is not the final version yet, is in alpha status. It lacks features and have plenty of bugs.



# Feedback

Do you want new features? Are there some weird bug to fix? Feel free to post your suggestions or bug reports in our [issue tracking tool](https://github.com/mmazzei/Pomodorin/issues). Or, if you don't have a GitHub account, just send me an email (email address visible in my [public profile](https://github.com/mmazzei)).

Do you want to contribute? Pull requests are welcomed!



# 3rd Party licenses

"Pomodoro (R)" and "Pomodoro Technique (R)" are registered trademarks by [<NAME>](http://pomodorotechnique.com).
<commit_msg>Grammar corrections for the README.md file<commit_after>[Versión en español](README_es.md)

# Introduction

On the daily use of the *Pomodoro Technique (R)*, I prefer to use a pencil and a diary for task tracking. Handwriting all of that allows me to be more conscious of pending things to do.

So, I was looking for a simple timer for this technique, including some features that are boring to do with pencil and paper, like record diary statistics of finished pomodoris and interruptions and not much more.

Most of the best software tools found for this technique available, include functionality that makes the UI more complex or distractive, like TO-DO lists, tasks categories and lots of options I do not want to be present there. Or, in the other extreme, are just too simple.

As couldn't find what I needed, I implemented this one.



# Download

Checkout the most recent release [here](https://github.com/mmazzei/Pomodorin/releases).



# Usage

The UI target is to be simple and clear. If you always click at the big image in the center, it will do what you need most of the time.


## How to start a new pomodori?

You can click on the big tomato button:

  ![Main view](readmeAssets/mainScreen.png)

If you just finished a break, the following window will be shown:

![Deciding next step](readmeAssets/decideWhatIsNext_tomato.png)

That could be different, depending on your current session, because Pomodorin will recommend you the next step, making that button bigger than the alternatives. So, if you just finished a pomodori, that window will look like:

![Deciding next step](readmeAssets/decideWhatIsNext_shortBreak.png)

It doesn't matter if small or big, the tomato button starts a pomodori.


## How to start a break?

Just by clicking on the hourglass buttons.

Short break:
![Short break](readmeAssets/half_hourglass.png)

Long break:
![Long break](readmeAssets/full_hourglass.png)


## How to stop a pomodori or break?

The small "-" button at the bottom of the screen is what you want.


## How to automatically start pomodoris and breaks?

There is an *experimental* feature to do so: **Auto-mode**.

When Pomodorin is running in Auto-mode, it will automatically start the next pomodori, short break or long break, depending on your previous actions.

You can activate that by clicking the small lock icon at the bottom of the screen.

If you close the Pomodorin application, the next pomodori or break will not be automatically started until you open it again.


# FAQ

## What is the meaning of the version name?

"A mi me anda" is a common software developer excuse. The meaning in english is: "It works for me".

If you are a programmer and need some ideas for your excuses, there is a nice site that can be helpful for you: [programmingexcuses.com](http://programmingexcuses.com).

If you are not a programmer, do as if you never read this part. We do not invent excuses, those phrases are true comments from the soul!


## Why is this page, the code and the UI are so badly written?

English is not my main language (good excuse!). Hope to have a collaborator to improve this in order to remove this question from here.


## How do you do to have a FAQ if there are no users yet?

Ok, I invented the questions to fill some space here.

Was either that or sit and write the next awesome Pomodorin feature.


## Why is the Pomodorin application so bad?

This is not the final version yet, it is in alpha status. It lacks features and has plenty of bugs.



# Feedback

Do you want new features? Is there some weird bug to fix? Feel free to post your suggestions or bug reports in our [issue tracking tool](https://github.com/mmazzei/Pomodorin/issues). Or, if you don't have a GitHub account, just send me an email (email address visible in my [public profile](https://github.com/mmazzei)).

Do you want to contribute? Pull requests are welcomed!



# 3rd Party licenses

"Pomodoro (R)" and "Pomodoro Technique (R)" are registered trademarks by [<NAME>](http://pomodorotechnique.com).

{'fraction_non_alphanumeric': 0.058226897069872274, 'fraction_numerical': 0.00025043826696719256, 'mean_word_length': 4.21685173089484, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3764118', 'n_tokens_mistral': 2229, 'n_tokens_neox': 2110, 'n_words': 1237}