Skip to content

Commit

Permalink
added readme, shortcuts
Browse files Browse the repository at this point in the history
  • Loading branch information
debottamKundu committed Jan 13, 2021
1 parent 5584cb2 commit aa2f442
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
7 changes: 6 additions & 1 deletion Default.sublime-commands
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
[
{
"caption": "Pomodoro",
"caption": "Pomodoro:Start Clock",
"command": "pomodoro_start"
},
{
"caption": "Pomodoro:Reset Clock",
"command": "pomodoro_stop"
}

]
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
# pomodoro_timer
Package for Sublime Text
# Pomodoro Timer

The **Pomodoro Technique** is a time management technique developed by Francesco Cirillio. It invloves using a timer to break down your work time into intervals, traditionally 25 minutes in length, wtih 5 minute breaks in between. It is recommended to take a longer break after 4 such cycles.

The package is fairly simple and involves a default setting of 25 minutes of work, 5 minutes of break and 4 such alternating cycles before the timer resets. You can change the timing intervals or the number of cycles from the package settings.

You can start and stop the timers from the command pallate, or use the shortcut `Ctrl+Alt+P` to start the clock and `Ctrl+Alt+R` to reset it.

Let me know if you have any features that you would like to be added.

4 changes: 2 additions & 2 deletions pomodoro.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ def reset():
sublime.status_message("Your pomodoro timer has been cancelled")
else:
sublime.pomodoro_clock = False
sublime.status_message("Your pomodoro timer has ended. Please reset using shortcut.")
sublime.message_dialog("Your pomodoro timer has ended.")
sublime.status_message("Your pomodoro timer has ended.")
sublime.message_dialog("Your pomodoro timer has ended. Take a well deserved break.")
return
# print("Everything ends")

Expand Down

0 comments on commit aa2f442

Please sign in to comment.