mirror of
https://github.com/elisspace/pomodoro-cli.git
synced 2026-08-29 15:44:05 +00:00
51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
# Pomodoro-cli
|
|
Simple command line pomodoro program to focus.
|
|
|
|
|Menu|
|
|
|-|
|
|
||
|
|
|Concentration Timer|
|
|
||
|
|
|Break Timer|
|
|
|
|
|
|
|
The pomodoro-cli program alows the user to have a simple and visually attractive pomodoro timer on their terminal.
|
|
|
|
## Installation
|
|
To install the program you can do one of the following methods:
|
|
|
|
### Linux and MacOS
|
|
`cd` to the directory where you want to install the program and run:
|
|
```
|
|
$ git clone https://github.com/0kron/pomodoro-cli/pomodoro
|
|
```
|
|
You can run the program using
|
|
```
|
|
$ python3 $HOME/path/to/the/git_clone/main.py
|
|
```
|
|
Or assaign an `alias` to the command on `.bashrc`:
|
|
```
|
|
alias pomodoro='python3 $HOME/path/to/the/git_clone/main.py
|
|
```
|
|
|
|
### Windows
|
|
Copy the files in this repository to a folder of your combenience and make sure you have Python in your PATH by running:
|
|
```
|
|
python --version
|
|
Python 3.10.X
|
|
```
|
|
Note that this program works with some new features just included on Python 3.10, an update version of Python can be located [here](https://www.python.org/downloads/).
|
|
|
|
To run the program follow the following command:
|
|
```
|
|
> python3 C:\Users\user\path\of\the\folder\main.py
|
|
```
|
|
Or create and alias using the `DOSKEY` command like:
|
|
```
|
|
> DOSKEY pomodoro=python3 C:\Users\user\path\of\the\folder\main.py
|
|
```
|
|
To that last option follow [this](https://shivamethical.medium.com/create-command-line-alias-in-windows-76684635b4c4) guide for creating a `*.bat` file.
|
|
|
|
|
|
**Note:** this program is for free use, recommendations and questions may be asked through this repository.
|