Artikulate is a pronunciaton trainer, currently in the Edu Playground. This means the application is not released yet and still under development! Please take this in mind when looking at the application. Though already now, all kinds of bug reports are very welcomed!
Setting up Development or Testing Environment
The following general steps are mandatory:
- setup development enviroment for KDE applications
- get the Artikulate source code
- configure the build system
- compile Artikulate
- install Artikulate
- set KDEDIRS and run QML_IMPORT_PATH
- run Artikulate
Some of these steps need further explenations:
Artikulate Development Environment
Usually it is not necessary to compile kdelibs and Qt by yourself! The current master branch only requires development packges of the following framewoks:
- KDE >= 4.10
- Qt >= 4.8
- CMake >= 2.8.9
- QtMobility with component QtMultimedia
Those package are usually provided by your distribution. Not that you also must install the development packages (often indicated by a trailing "-dev" in the package name).
Example: Development Packages on Debian
Get the Source Code
You can fetch the sources from the Artikulate Project Page by cloning the Git repository. Let's say for the further explenations here that you fetch the source to: "$HOME/artikulate-source" (replace $HOME by the path to your home directory!)
Configure Your Build-System
Next, we need folders for building and for installing Artikulate. Let's say we create folders
Then we need to say the build-scripts that those folders exist. Very comfortable this can be done by using the program cmake-gui. Take care to set the following variables:
- Source-directory is: $HOME/artkulate-source
- Build-directory is: $HOME/artikulate-build
- set: CMAKE_BUILD_TYPE = debugfull
- set: CMAKE_INSTALL_PREFIX = $HOME/artikulate-install
Then press "configure" to see if all necessary libraries are present. Maybe you must press configure twice to get all red warnings resolved. If nothing red remains, all dependencies are found. To generate the build files, press "Generate".
Setup Execution Enviroment and Run Artikulate
It is necessary that the following variables are set when executing the application. This can either be done in your IDE (like KDevelop or QtCreator) or at the console with the export command, i.e.:
- export KDEDIRS=$HOME/artikulate-install:$KDEDIRS
- export QML_IMPORT_PATH=/usr/lib/kde4/imports:$HOME/artikulate/share/apps/artikulate/qml/
(the QML_IMPORT_PATH depends on your distribution, i.e., the first part could be for example also "/usr/lib64/kde4" or similar; you find the correct path by searching in your file system where the file structure .../imports/org/kde/plasma/core/ exists)
Finally, you can run your build Artikulate binaries in $HOME/artikulate-install/bin/artikulate.
Getting data files (artikulate-data repository)
All course material for Artikulate can be found and edited in the following repository:
For licensing information please see:
You can contribute to this repository with a KDE Developer account. But also if you do not have a KDE Developer account (yet), we are happy to get contributions. For those cases, please write to the mailing list .
Using the Repository Directly in Artikulate
To work with Artikulate directly at this course material repository please create a local copy of it (git clone). Then start Artikulate and go to the dialog "Settings" (top-left button) and select the root folder of your local copy in that dialog as your course material repository. After restarting Artikulate the training mode as well as the editor mode operate only on the data from the repository.