QUICKSTART.md 3.2 KB

Quick Start Guide

First Time Setup

Windows

  1. Double-click setup.bat
  2. Wait for installation to complete
  3. Double-click run.bat to start the app

Linux

  1. Open terminal in the project folder
  2. Run: chmod +x setup.sh run.sh
  3. Run: ./setup.sh
  4. Run: ./run.sh

Basic Usage

Step 1: Create Your First Timer

  1. Click "Add Timer"
  2. Enter a name (e.g., "5 Minute Break")
  3. Set duration using HH:MM:SS format (e.g., 00:05:00 for 5 minutes)
  4. Customize colors and font size if desired
  5. Click "Save"

Step 2: Configure Monitor (Optional)

  1. Click "Settings"
  2. Select which monitor to use for fullscreen display
  3. Click "Save"

Step 3: Start Timers

  1. Select a timer from the Timer Library
  2. Click "Start Selected Timer"
  3. Timer appears in the Active Timers panel on the right
  4. Start as many timers as you need - they all display together
  5. Use individual controls on each timer or global controls

Step 4: Control Your Timers

Individual Timer Controls (on each timer):

  • Pause/Resume: Pause or resume that specific timer
  • Restart: Reset the timer to its original duration
  • Stop: Stop and remove that timer

Global Controls (in the left panel):

  • Pause All Timers: Pause all running timers at once
  • Resume All Timers: Resume all paused timers
  • Stop All Timers: Stop and remove all timers

Fullscreen Display (optional):

  • Click "Show Fullscreen on Monitor" to display all timers fullscreen
  • Timers split the screen evenly (1 timer = full height, 2 = 50% each, etc.)
  • Font sizes auto-adjust for optimal visibility
  • Perfect for presentations or viewing from a distance
  • Press ESC to exit fullscreen mode
  • Control timers from the main window while in fullscreen

Tips

  • Duration: Use HH:MM:SS format (00:05:00 = 5 minutes, 01:00:00 = 1 hour)
  • Multiple Timers: Run as many timers as you need - all visible in one window
  • Fullscreen Mode: Great for presentations, meetings, or viewing on a TV
  • Multi-Monitor: Configure which monitor shows fullscreen timers
  • Individual Controls: Each timer has Pause, Restart, and Stop buttons
  • Global Controls: Use Pause All/Resume All/Stop All for quick management
  • Pause Feature: Pause individual timers or all at once when needed
  • Quick Restart: Made a mistake? Use the Restart button to start over
  • Colors: Use contrasting colors for better visibility
  • Timer Library: Save frequently used timers for quick access
  • Reusable: Start the same timer configuration multiple times

Common Durations

  • 1 minute = 00:01:00
  • 5 minutes = 00:05:00
  • 10 minutes = 00:10:00
  • 15 minutes = 00:15:00
  • 30 minutes = 00:30:00
  • 1 hour = 01:00:00
  • 2 hours = 02:00:00

Troubleshooting

App won't start on Windows:

  • Make sure Python is installed
  • Run python --version in Command Prompt
  • Re-run setup.bat

App won't start on Linux:

  • Make sure Python 3 is installed
  • Run python3 --version in terminal
  • Make scripts executable: chmod +x setup.sh run.sh
  • Re-run ./setup.sh

Can't see timer text:

  • Edit the timer and change text color
  • Use high contrast (white on black or vice versa)
  • Adjust font size in timer settings