Skip to content

Latest commit

 

History

History
189 lines (127 loc) · 6.39 KB

README.md

File metadata and controls

189 lines (127 loc) · 6.39 KB
Raw

logo


iClock

Fully Customizable Clock Widget

Documentation python pyqt5 tag version license


iClock is an open-source, cross-platform desktop clock widget project. This project enables users to add an aesthetic and functional clock to their desktops. With the features offered by iClock, users can personalize their clocks and add a unique touch to their desktops.


banner


Table of Contents


Installation and Usage

To install iClock, follow these steps:

  1. Clone the repository:

    git clone https://github.com/odest/iClock.git

  2. Navigate to the iClock directory:

    cd iClock

  3. Install the required dependencies using pip:

    pip install -r requirements.txt

  4. Run the main.py script using Python:

    python main.py

By following these steps, you will have successfully installed iClock and its dependencies.



Important

  • If you encounter ModuleNotFoundError: No module named 'PyQt5.QtSvg' error in Linux, install the necessary modules as shown below:
sudo apt-get install python3-pyqt5.qtsvg
  • If you encounter ModuleNotFoundError: No module named 'PyQt5.QtX11Extras' error in Linux, install the necessary modules as shown below:
sudo apt-get install python3-pyqt5.qtx11extras

Customization Options

  • Background Customizations

    • Background Type
      • Gif
      • Image
      • Color
    • Background Opacity
    • Animation Duration
    • Border
      • Color
      • Size
      • Radius

  • Text Customizations

    • Size
    • Coord
    • Opacity
    • Color
    • Font

  • Settings

    • Show Tooltips
    • Show on Taskbar
    • Stays on Top
    • Blinking Colon
    • Advanced Options
    • Back to Default

Features

  • Fully Customizable: You can customize all components and details of the widget.
  • Your preferences are remembered: Once customized and saved, you can use it in the same way every time.
  • Ability to revert to default configurations: At any time, you can revert to the default configurations and start reconfiguring as needed.

  • Flexibility: You can bring and utilize the widget in any size you desire.
  • Mobility: You can move the widget anywhere you want and use it freely.
  • Positioning: You can position and use the widget wherever you desire by fixing it to your preferred location.

  • Tooltips: You can choose whether tooltips are displayed or not.
  • Taskbar Visibility: You can choose whether the widget appears on the taskbar.
  • Stays on Top: You can choose whether the widget appears above or below other applications.

  • Background GIF: You can add any animated GIF you want to the background.
  • Background Image: You can add any image you want to the background.
  • Background Color: You can add any color you want to the background.

Platform Support Test

A test result table regarding whether it works on which operating system:

Windows Linux MacOs
Platform Test Result
Windows 11 ${\color{#00FF00}passed}$
Windows 10 ${\color{#00FF00}passed}$
Windows 8.1 ${\color{#f28c07}not\space tested}$
Windows 8 ${\color{#f28c07}not\space tested}$
Windows 7 ${\color{#f28c07}not\space tested}$
Platform Test Result
MX Linux (MX-23.2 / Fluxbox / x64) ${\color{#00FF00}passed}$
Debian (12-12.5 / Gnome / x64) ${\color{#00FF00}passed}$
Platform Test Result
macOS 14 (Sonoma) ${\color{#f28c07}not\space tested}$
macOS 13 (Ventura) ${\color{#f28c07}not\space tested}$
macOS 12 (Monterey) ${\color{#f28c07}not\space tested}$
macOS 11 (Big Sur) ${\color{#f28c07}not\space tested}$
macOS 10.15 (Catalina) ${\color{#f28c07}not\space tested}$

Sources

Note

You can take a look at the assets.json file for more detailed information.


License

  • This project is licensed under the GPL-3.0 License - see the LICENSE file for details.