/kf5-qt5/education/gcompris/HACKING

0001                         GCompris HACKING
0002
0003 Official repository
0004 -------------------
0005 The official repository requires a KDE developer account, we will ask regular
0006 contributors to get an account and work on the KDE repository.
0007
0008     https://invent.kde.org/education/gcompris
0009
0010 For new developers and those interested only in smaller contributions use the
0011 https://phabricator.kde.org/ or GitHub repository.
0012
0013
0014 Source code from GitHub
0015 -----------------------
0016 Checkout the source code by cloning it from GitHub
0017
0018     git clone git://github.com/gcompris/GCompris-qt.git
0019
0020 If you want to have a personal fork, in order to commit occasional patches,
0021 fork it on GitHub then clone your fork
0022
0023     git clone git@github.com:<username>/GCompris-qt.git
0024
0025 When asking for a pull request, create a new topic branch and commit your
0026 changes there then open a pull request to gcompris-qt repository on GitHub.
0027
0028 See GitHub's documentation for more information.
0029
0030     https://help.github.com/categories/collaborating/
0031
0032
0033 Dependencies
0034 ------------
0035 In order to be able to compile GCompris the following Qt5 dependencies need to
0036 be installed (version 5.12 minimum)
0037
0038     Qt 5 Development Defaults
0039     Qt 5 qmake
0040     Qt Creator
0041     Qt Linguist Tools
0042
0043     Qt Core
0044     Qt Graphical Effects QML Module
0045     Qt Gui
0046     Qt Multimedia
0047     Qt Multimedia QML Module
0048     Qt Network
0049     Qt Qml
0050     Qt Quick
0051     Qt Svg
0052     Qt Charts (qml plugin)
0053
0054 CMake must be installed to compile GCompris:
0055
0056     sudo apt install cmake
0057
0058 By default, translations are also built so gettext package must be installed to compile GCompris (to ignore translation files, run cmake with `-DSKIP_TRANSLATIONS=ON`:
0059
0060     sudo apt install gettext
0061
0062 Installing dependencies on a Debian based systems can be done like this:
0063
0064     sudo apt install libqt5svg5-dev \
0065                           qml-module-qtmultimedia \
0066                           qml-module-qtgraphicaleffects qt5-qmake qtcreator \
0067                           qtdeclarative5-dev qtdeclarative5-dev \
0068                           qtmultimedia5-dev qtquickcontrols2-5-dev qttools5-dev \
0069                           qttools5-dev-tools libqt5multimedia5-plugins \
0070                           qml-module-qtsensors libqt5quickparticles5 \
0071                           qml-module-qtquick2 qml-module-qtquick-particles2 \
0072                           libqt5sensors5-dev libqt5sensors5 qml-module-qtcharts
0073
0074 To build for Android, Qt 5 AndroidExtras also needs to be installed.
0075
0076 If building from a .tar.gz or .zip source distribution the externals may
0077 need to be added.
0078
0079     cd GCompris-qt-*
0080     git clone https://github.com/qml-box2d/qml-box2d.git external/qml-box2d/
0081
0082
0083 Build
0084 -----
0085 Start QtCreator and select Open Project and open CMakeLists.txt in the
0086 gcompris-qt root directory. Follow the wizard instructions.
0087
0088 Use the buttons on the lower left side to build, run, and debug GCompris.
0089
0090 An alternative building process is to use cmake in command-line directly.
0091
0092     cd GCompris-qt-*
0093     mkdir build
0094     cd build
0095     cmake ..
0096     make
0097     ./bin/gcompris-qt
0098
0099 More Details
0100 ------------
0101 Go To this Link:
0102           https://gcompris.net/wiki/Qt_Quick_development_process