Warning, /education/ktouch/README.md is written in an unsupported language. File is not indexed.
0001 # KTouch 0002 0003 <a href='https://flathub.org/apps/details/org.kde.ktouch'><img height='56' alt='Get KTouch from Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'></a> 0004 <a href='https://snapcraft.io/ktouch'><img height='56' alt='Get KTouch from the Snap Store' src='https://snapcraft.io/static/images/badges/en/snap-store-black.svg'></a> 0005 0006  0007 0008 KTouch is a program to learn and practice touch typing. Every finger 0009 has its place on the keyboard with associated keys to press. Starting 0010 with only a few keys to remember you will advance through different 0011 training levels where additional keys are introduced. Because you no 0012 longer need to search for the keys on the keyboard you will be able 0013 to type quickly and accurately. 0014 0015 # Build Status 0016 0017 | Jenkins CI Name | Master | Stable | 0018 | --------------- | ------ | ------ | 0019 | OpenSuse Qt 5.14 | [](https://build.kde.org/job/Applications/job/ktouch/job/kf5-qt5%20SUSEQt5.14/) | [](https://build.kde.org/job/Applications/job/ktouch/job/stable-kf5-qt5%20SUSEQt5.14/) | 0020 | FreeBSD Qt 5.14 | [](https://build.kde.org/job/Applications/job/ktouch/job/kf5-qt5%20FreeBSDQt5.14/) | [](https://build.kde.org/job/Applications/job/ktouch/job/stable-kf5-qt5%20FreeBSDQt5.14/) | 0021 0022 # Development Setup 0023 0024 ## Quick Start 0025 0026 In the top level directory there is a script called `build-install-run` 0027 which can be used to configure, build, install and run KTouch in one 0028 step. Execute: 0029 0030 ./build-install-run 0031 0032 in the top-level directory of the KTouch repository to get started. 0033 It is just simple wrapper arround CMake and set ups the necessary 0034 environment variables to run KTouch. Build artifacts are stored in 0035 the subdirectory `build/`, install files go to `install/`. 0036 0037 ## Building 0038 0039 KTouch has the following build dependencies: 0040 0041 * [CMake][cmake] ≥ 3.0.0 0042 * [Extra CMake Modules][ecm] ≥ 1.0.0 0043 * [Qt][qt] ≥ 5.9 with the following modules 0044 * Qt GUI 0045 * Qt QML 0046 * Qt Quick 0047 * Qt Quick Widgets 0048 * Qt Quick Controls 2 0049 * Qt SQL 0050 * Qt Test 0051 * Qt XML 0052 * Qt XML Patterns 0053 * [KDE Frameworks 5][kf5] with: 0054 * Completion 0055 * Config 0056 * ConfigWidgets 0057 * CoreAddons 0058 * Declarative 0059 * DocTools 0060 * I18n 0061 * ItemViews 0062 * KCMUtils 0063 * KIO 0064 * TextWidgets 0065 * WidgetsAddons 0066 * WindowSystem 0067 * XmlGui 0068 * IconThemes 0069 * optionally, for keyboard layout auto-detection: 0070 * Qt X11 Extras 0071 * [Xlib][xlib] 0072 * [XKB][xkb] 0073 * [libxkbfile][libxkbfile] 0074 * [libxcb][libxcb] with libxcb-xkb 0075 0076 [cmake]: https://cmake.org/ 0077 [ecm]: https://invent.kde.org/frameworks/extra-cmake-modules/ 0078 [qt]: https://www.qt.io/ 0079 [kf5]: https://api.kde.org/frameworks/ 0080 [xlib]: https://tronche.com/gui/x/xlib/ 0081 [xkb]: https://www.x.org/wiki/XKB/ 0082 [libxkbfile]: https://gitlab.freedesktop.org/xorg/lib/libxkbfile 0083 [libxcb]: https://xcb.freedesktop.org/ 0084 0085 Collecting and installing all dependencies by hand can be a challenge. 0086 Far easier is to use the dependency resolution of your package 0087 manager. Usually they can be instructed to install all dependencies 0088 automatically by using the information of the packaged version of 0089 KTouch: 0090 0091 apt-get build-dep ktouch # Ubuntu, Debian, ... 0092 zypper source-install --build-deps-only ktouch # openSUSE 0093 0094 If the build requirements are met, execute the following commands in 0095 the root directory of your working copy to built and install KTouch: 0096 0097 mkdir build 0098 cd build 0099 cmake .. -DCMAKE_INSTALL_PREFIX=../install 0100 make 0101 make install 0102 0103 These commands install KTouch to the directory `install` in the root of 0104 your working copy. You can install KTouch to any directory of your 0105 choice by passing a different path to `-DCMAKE_INSTALL_PREFIX`. 0106 0107 ## Running 0108 0109 At runtime KTouch needs the following additional software packages to be 0110 installed: 0111 0112 * [Breeze icon set][breeze] 0113 * [kqtquickcharts][kqtquickcharts] ≥ 16.12 0114 * [plasma-desktop][plasma-desktop] (optional, for keyboard layout 0115 configuration inside the application) 0116 0117 [breeze]: https://phabricator.kde.org/source/breeze-icons/ 0118 [kqtquickcharts]: https://phabricator.kde.org/source/kqtquickcharts/ 0119 [plasma-desktop]: https://phabricator.kde.org/source/plasma-desktop/ 0120 0121 KTouch needs the following environment variables to be set in order 0122 to find all its installed resources: 0123 0124 export KDEDIRS=<full-path-to-install-dir>:$KDEDIRS 0125 export XDG_DATA_DIRS=<full-path-to-install-dir>/share:$XDG_DATA_DIRS 0126 0127 After this, KTouch can finally be launched with: 0128 0129 <path-to-install-dir>/bin/ktouch