Skip to content

Home

Jump to bottom
Dmitry Sorokin (@sorydima) edited this page Nov 18, 2024 · 1 revision

Wiki for the Katya ® DeskClock Repository

Welcome to the Katya ® DeskClock repository! This wiki provides information on how to use, develop, and contribute to the DeskClock application, a versatile time-management tool tailored for the Katya ecosystem.

Overview

The Katya ® DeskClock application combines a sleek design with powerful timekeeping features. It offers a reliable and customizable solution for managing alarms, timers, stopwatches, and world clocks, designed to align with the privacy-focused and user-centric principles of Katya.

Table of Contents

  1. Getting Started
  2. Repository Structure
  3. Features
  4. Installation
  5. Configuration
  6. Contributing
  7. Troubleshooting
  8. Licensing

Getting Started

  1. Clone the Repository

    git clone https://github.com/Katya-Incorporated/platform_packages_apps_DeskClock.git

  2. Set Up Development Tools
    Install Android Studio or a similar IDE to explore and modify the application.

  3. Explore the Application
    Familiarize yourself with the features and design of the DeskClock app.

Repository Structure

  • /src: Core source code for the DeskClock application.
  • /res: UI resources, icons, layouts, and translations.
  • /docs: Developer documentation and user guides.
  • /tests: Automated tests for validating app functionality.
  • /build: Build scripts and configuration files.

Features

  1. Alarms

    • Create, manage, and customize multiple alarms with flexible scheduling.

  2. Timers

    • Set countdown timers with optional notifications or custom sounds.

  3. Stopwatch

    • A precise stopwatch with lap tracking and sharing options.

  4. World Clock

    • View time zones for multiple locations with a customizable interface.

  5. Dark Mode Support

    • An eye-friendly dark mode for comfortable usage in low-light environments.

  6. Offline Functionality

    • Fully operational without internet connectivity.

Installation

  1. Build the Application
    Compile the app using Gradle:

    ./gradlew assembleDebug

  2. Install the APK
    Deploy the APK to your device or emulator:

    adb install -r app/build/outputs/apk/debug/app-debug.apk

  3. Run the Application
    Open the DeskClock app and start using its features.

Configuration

  1. Alarm Settings

    • Adjust alarm tones, vibration patterns, and snooze duration in the settings.

  2. Timer Defaults

    • Set default timer durations for quick access.

  3. World Clock Locations

    • Add or remove cities to customize the world clock display.

  4. Themes

    • Switch between light and dark themes from the app settings.

Contributing

We welcome contributions to improve the Katya ® DeskClock app.

  1. Fork the Repository
    Create a personal copy of the repository on your GitHub profile.

  2. Create a Branch
    Use a descriptive branch name for your changes.

  3. Submit Pull Requests
    Provide a clear description of your updates and link any relevant issues.

  4. Follow Contribution Guidelines
    Refer to the CONTRIBUTING.md file for detailed instructions.

Troubleshooting

  1. Debugging Issues
    Use adb logcat to monitor app logs and identify errors.

  2. Known Issues
    Check the Issues page for a list of reported bugs and their statuses.

  3. Additional Help
    Refer to the /docs folder for troubleshooting guides and FAQs.

Licensing

The DeskClock application is licensed under the Katya Open Source License. Feel free to use, modify, and distribute it under these terms.

Thank you for supporting Katya ® DeskClock! Together, we are building a user-friendly and reliable timekeeping tool for everyone.

Clone this wiki locally