TuiTimerX

A speed cube timer inspired by cstimer right in your terminal. With TUI components made using textual python library.

This project is still under development

Screenshots

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repository and cd into the working directory:

   git clone https://github.com/llyram/TuiTimerX.git
   cd TuiTimerX

2. Create a python virtual environment:

   virtualenv venv && source venv/bin/activate

3. Install dependencies:

   pip install -r requirements.txt

4. Run the application:

   python main.py

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repository and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request