search

k4j8 / pomodoro

simple command line pomodoro app with visualization of statistics
MIT License
1 stars 0 forks source link

Add descriptions to configuration file #6

Open k4j8 opened 4 years ago

k4j8 commented 4 years ago

Add comments to describe what each of the properties does in the configuration file. Ideally, this would be the same as pomodoro --help.

k4j8 commented 4 years ago

Combine autostart and description into one flag.

Format of the program:

  1. User starts pomodoro
  2. User is prompted for description of work if descriptions are enabled
  3. Timer begins for work
  4. See next timer steps below
  5. Timer begins for rest
  6. See next timer steps below
  7. Repeat starting at step 3

Next timer steps

Notifications on, descriptions on: Pop-up box with text entry for description

Notifications on, descriptions off: Pop-up box

Notifications off, descriptions on: CLI prompt for description

Notifications off, descriptions off: Auto-start the next cycle

k4j8 commented 4 years ago

Better option: descriptions are always on, but notifications can be set to pop-up box (within box for description input), CLI, or off. If off, descriptions are not possible.

Doing it this way prevents the need for a descriptions flag.