Skip to content

Latest commit

 

History

History
39 lines (33 loc) · 1.4 KB

README.md

File metadata and controls

39 lines (33 loc) · 1.4 KB

pomodoro_curses

A simple pomodoro timer written with the Ncurses library

Dependencies

  • GNU make
  • libinih
  • ncurses

Features

  • ncurses interface
  • Separate timer and status windows
    • User-friendly status messages to indicate whether working or on break
  • Command-line flags to control program settings
  • Configuration file to persistently store preferred settings
  • Basic bell indicator of beginnings and ends of time periods
  • Better sound playback to indicate the beginnings and ends of time periods
    • Sound for the start of a work session
    • Sound for the end of a work session (beginning of a break)
      • Sound for the beginning of a short break
      • Sound for the beginning of a long break
  • man page documenting the program
    • Installation of man page in an appropriate location to be found by man

Installation

  1. Ensure dependencies are installed.
  2. make
    • This will compile the program and run all unit tests
  3. make install
    • Currently only installs per user, so elevated privileges are not needed

Notes