| 1 | GCompris HACKING |
|---|
| 2 | |
|---|
| 3 | Official repository |
|---|
| 4 | ------------------- |
|---|
| 5 | The official repository requires a KDE developer account, we will ask regular |
|---|
| 6 | contributors to get an account and work on the KDE repository. |
|---|
| 7 | |
|---|
| 8 | http://quickgit.kde.org/?p=gcompris.git |
|---|
| 9 | |
|---|
| 10 | For new developers and those interested only in smaller contributions use the |
|---|
| 11 | GitHub repository. |
|---|
| 12 | |
|---|
| 13 | |
|---|
| 14 | Source code from GitHub |
|---|
| 15 | ----------------------- |
|---|
| 16 | Checkout the source code by cloning it from GitHub |
|---|
| 17 | |
|---|
| 18 | git clone git://github.com/gcompris/GCompris-qt.git |
|---|
| 19 | |
|---|
| 20 | If you want to have a personal fork, in order to commit occasional patches, |
|---|
| 21 | fork it on GitHub then clone your fork |
|---|
| 22 | |
|---|
| 23 | git clone git@github.com:<username>/GCompris-qt.git |
|---|
| 24 | |
|---|
| 25 | When asking for a pull request, create a new topic branch and commit your |
|---|
| 26 | changes there then open a pull request to gcompris-qt repository on GitHub. |
|---|
| 27 | |
|---|
| 28 | See GitHub's documentation for more information. |
|---|
| 29 | |
|---|
| 30 | https://help.github.com/categories/collaborating/ |
|---|
| 31 | |
|---|
| 32 | |
|---|
| 33 | Dependencies |
|---|
| 34 | ------------ |
|---|
| 35 | In order to be able to compile GCompris the following Qt5 dependencies need to |
|---|
| 36 | be installed |
|---|
| 37 | |
|---|
| 38 | Qt 5 Development Defaults |
|---|
| 39 | Qt 5 qmake |
|---|
| 40 | Qt Creator |
|---|
| 41 | Qt Linguist Tools |
|---|
| 42 | |
|---|
| 43 | Qt Core |
|---|
| 44 | Qt Graphical Effects QML Module |
|---|
| 45 | Qt Gui |
|---|
| 46 | Qt Multimedia |
|---|
| 47 | Qt Multimedia QML Module |
|---|
| 48 | Qt Network |
|---|
| 49 | Qt Qml |
|---|
| 50 | Qt Quick |
|---|
| 51 | Qt Svg |
|---|
| 52 | Qt Xml |
|---|
| 53 | Qt XmlPatterns |
|---|
| 54 | |
|---|
| 55 | Installing dependencies on a Debian based systems can be done like this: |
|---|
| 56 | |
|---|
| 57 | sudo aptitude install libqt5svg5-dev libqt5xmlpatterns5-dev \ |
|---|
| 58 | qml-module-qtmultimedia qt5-default \ |
|---|
| 59 | qml-module-qtgraphicaleffects qt5-qmake qtcreator \ |
|---|
| 60 | qtdeclarative5-dev qtdeclarative5-dev \ |
|---|
| 61 | qtmultimedia5-dev qtquick1-5-dev qttools5-dev \ |
|---|
| 62 | qttools5-dev-tools libqt5multimedia5-plugins \ |
|---|
| 63 | qml-module-qtsensors libqt5quickparticles5 \ |
|---|
| 64 | qml-module-qtquick2 qml-module-qtquick-particles2 \ |
|---|
| 65 | libqt5sensors5-dev libqt5sensors5 |
|---|
| 66 | |
|---|
| 67 | To build for Android, Qt 5 AndroidExtras also needs to be installed. |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | Build |
|---|
| 71 | ----- |
|---|
| 72 | Start QtCreator and select Open Project and open CMakeLists.txt in the |
|---|
| 73 | gcompris-qt root directory. Follow the wizard instructions. |
|---|
| 74 | |
|---|
| 75 | Use the buttons on the lower left side to build, run, and debug GCompris. |
|---|
