update name change to pomo to avoid conflict with pom moon stats. changed default number of pomos. added unlicense.

This commit is contained in:
Lee 2023-08-25 13:09:25 -04:00
parent 633eb0ca03
commit 0105443166
3 changed files with 13 additions and 13 deletions

View File

@ -1,9 +1,9 @@
pom
===
pomo
====
pom is a time management system for getting projects done, based on the Pomodoro Technique originally developed by Francesco Cirillo. The traditional method is to use a tomato ("pomodoro" in Italian) timer set for 25 minutes to work on a task, then take a 5-10 minute break. One set of work time plus the break is called a "pomodoro." Typically one completes 4 sets of pomodoros before taking a longer 20-30 minute break.
pomo is a time management system for getting projects done, based on the Pomodoro Technique originally developed by Francesco Cirillo. The traditional method is to use a tomato ("pomodoro" in Italian) timer set for 25 minutes to work on a task, then take a 5-10 minute break. One set of work time plus the break is called a "pomodoro." Typically one completes 4 sets of pomodoros before taking a longer 20-30 minute break.
pom has an audible bell sound after each pomodoro and each break, played via the program sox.
pomo has an audible bell sound after each pomodoro and each break, played via the program sox.
### Dependencies
@ -16,12 +16,12 @@ INSTALL
Using the luarocks package manager:
```
git clone https://tildegit.org/exquisitecorp/pom.git
cd pom
git clone https://tildegit.org/exquisitecorp/pomo.git
cd pomo
luarocks install lua-term
luarocks install alt-getopt
chmod +x pom
chmod +x pomo
```
Optional: Move pom to your path such as ~/.local/bin or /usr/local/bin to execute it anywhere.
@ -29,7 +29,7 @@ Optional: Move pom to your path such as ~/.local/bin or /usr/local/bin to execut
USAGE
-----
```pom``` sets a 25 minute pomodoro timer with 5 minute break.
```pomo``` by default sets a 25 minute pomodoro timer with 5 minute break, repeating 4 times.
Additional options:
@ -37,12 +37,12 @@ Additional options:
```
SYNOPSIS
pom [OPTION] [ARGUMENT]
pomo [OPTION] [ARGUMENT]
DESCRIPTION
-t --times <amount>
amount of pomodoros to run. Default = 1
amount of pomodoros to run. Default = 4
-n --nobreak
suppresses 5 minute break timer after completing a pomodoro

0
UNLICENSE Normal file → Executable file
View File

View File

@ -28,15 +28,15 @@ function print_help()
print([[
NAME
pom - pomodoro method timer
pomo - pomodoro method timer
SYNOPSIS
pom [OPTION] [ARGUMENT]
pomo [OPTION] [ARGUMENT]
DESCRIPTION
-t --times <amount>
amount of pomodoros to run. Default = 1
amount of pomodoros to run. Default = 4
-n --nobreak
suppresses 5 minute break timer after completing a pomodoro