Difference between revisions of "An exercise for new contributors"

From GCompris
Jump to: navigation, search
(add request to configure git name and email)
(adding git submodule init && git submodule update for box2d)
Line 10: Line 10:
** git clone https://github.com/bdoin/GCompris-qt
** git clone https://github.com/bdoin/GCompris-qt
** cd GCompris-qt
** cd GCompris-qt
** git submodule init && git submodule update (to retrieve box2d)
* Configure you Git username and email
* Configure you Git username and email
** git config --global user.email "your_email@example.com"
** git config --global user.email "your_email@example.com"

Revision as of 20:31, 7 November 2015


In order to help you practice in the GCompris framework, I propose you to make this little exercise.

Mandatory: GCompris development is done on a GNU/Linux distribution of your choice.

  • Install GNU/Linux on your computer if you don't already have it.
  • Download and Install the lastest stable version of QtCreator for Android
  • Get the GCompris code from the Kde Git version control system (or see bellow the GitHub option).
  • Configure you Git username and email
    • git config --global user.email "your_email@example.com"
    • git config --global user.name "FirstName LastName"
  • Create a branch for your development
    • git checkout -b exercise
  • Start QtCreator and open the project file CMakeLists.txt at the root of the source code
  • Compile and run it.
  • Create a new activity using the supplied createit.sh script. For example, use your nick name as the activity name.
    • cd src/activities
    • ./createit.sh 'my new activity'
  • Compile GCompris again in Qt Creator, check you new activity is present
  • Modify the activity to display an image, a rectangle and a text.
  • (Warning, if you add resources in you activity's resource directory you must run cmake again).
  • Add an event to a graphical object so that clicking on it does something visual.
  • Use git add and git commit to commit your changes locally.
    • git add 'my new activity'
    • git commit -a

Publish your patch on GitHub

  • Create an account on github
  • Fork [git@github.com:bdoin/GCompris-qt.git GCompris]
  • Code your activity
  • Commit the code
  • Push it
    • git push
  • On github send me a pull request