Giter Club home page Giter Club logo

catmodoro's Introduction

Catmodoro Timer

The Catmodoro Timer is a command-line based productivity tool built in Rust, inspired by the Pomodoro Technique. It aids in managing work sessions with set intervals, providing users with a simple interface to focus on time management effectively. The application includes features for pausing and resuming the timer, as well as the option to exit at any stage of the session.

Features

  • Customizable session durations
  • Terminal-based countdown timer
  • Pause and resume functionality
  • Ability to exit the timer at any point
  • Visual, color-coded timer status

Installation

To use the Catmodoro Timer, you must have Rust and Cargo installed on your system. For installation instructions, please refer to the Rust official installation guide.

Follow these steps to install the Catmodoro Timer:

  1. Clone the repository:

    git clone https://github.com/josesustaita/catmodoro.git
    cd catmodoro
  2. Compile the project using Cargo:

    cargo build --release
  3. The compiled binary will be located in target/release. You can execute it from there or add it to your path for convenience.

Usage

Run the timer with the default setting (25 minutes) by executing the binary:

./catmodoro

For a custom session length, use the -d or --duration flag with the desired number of minutes:

./catmodoro -d 15

Controls

  • p: Pause or resume the session.
  • q or Esc: Quit the timer.

Exiting

You can exit the Catmodoro Timer anytime by pressing q or the Escape key.

Contributions

Your contributions are welcome! If you would like to contribute to the project, please feel free to make a pull request or open an issue on GitHub.

License

This project is released under the MIT License.

catmodoro's People

Contributors

josesustaita avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.