pim/ktimetracker/README.md

0001
0002 # KTimeTracker
0003
0004 [KTimeTracker](https://apps.kde.org/ktimetracker/) tracks time spent on various tasks. It is useful for tracking hours to be billed to different clients or just to find out what percentage of your day is spent playing Doom or reading Slashdot.
0005
0006 You can install KTimeTracker on Linux via [Discover](appstream://org.kde.ktimetracker.desktop) or as a [flatpak on Flathub](https://flathub.org/apps/details/org.kde.ktimetracker). You can also install KTimeTracker (built with Qt 5) for [Windows](https://binary-factory.kde.org/job/KTimeTracker_Stable_win64/).
0007
0008 <a href='https://flathub.org/apps/details/org.kde.ktimetracker'><img width='190px' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a>
0009
0010 If you'd like to contribute to KTimeTracker, see [CONTRIBUTING.md](CONTRIBUTING.md).
0011
0012 ## Structure
0013
0014 * [src/dialogs/](src/dialogs): dialogs used for small tasks (creating tasks, editing time, history, export)
0015 * [src/export/](src/export): the logic for exporting backup copies in multiple formats
0016 * [src/file/](src/file): the main session file in `~/.local/share/ktimetracker/ktimetracker.ics`
0017 * [src/import/](src/import): used to import GNOME Planner files
0018 * [src/model/](src/model): the base for events/tasks/projects
0019 * [src/settings/](src/settings): the Settings dialog, as well as the KConfigXT files
0020 * [src/widgets/](src/widgets): specialized widgets (search bar, percent progress bar, context menus)
0021
0022 The `kf5` branch includes the latest Qt5 version. It will no longer receive updates.
0023
0024 The `master` branch includes the latest Qt6 version. It does not have a Windows build.
0025
0026 ## Building
0027
0028 The easiest way to make changes and test KTimeTracker during development is to build it with [kdesrc-build](https://community.kde.org/Get_Involved/development/Build_software_with_kdesrc-build).
0029
0030 To build it as a standalone app:
0031
0032 ```bash
0033 cmake -B build/ -DCMAKE_INSTALL_PREFIX=$HOME/kde/usr
0034 cmake --build build/
0035 cmake --install build/
0036 ```
0037
0038 Use `-DBUILD_TESTING=ON` to enable tests.
0039
0040 ## Credits
0041
0042 KTimeTracker was originaly written by Sirtaj Singh Kang and named KArm. The word "karm" means "work" in the author's native Punjabi.
0043
0044 KTimeTracker was inspired by Harald Tveit Alvestrand's very useful utility called titrax; we added some eyecandy and functionality like subtasks.