Vous souhaitez contribuer à Actionaz, mais vous ne savez pas par où commencer. Cette page va vous donner quelques indications pour vous faciliter les premières étapes.

Les sources d'Actionaz sont stockées sur GitHub

Une des premières taches va être de cloner le 'repository'

Puis de configurer votre environnement de développement local.

Se rendre sur http://github.com, et ouvrir un compte (pour cela un nom, un mail et un mot de passe).

Ensuite en cherchant actionaz vous trouverez le projet Jmgr/actionaz. En cliquant dessus vous aurez accès en consultation à l'ensemble des sources (que l'on dénomme le 'repository').

Lorsque vous regardez avec votre compte GitHub le repository de Jmgr/actionaz vous avez la possibilité de le cloner (le mot employé par GitHub est fork). Pour lancer le clonage il suffit d'appuyer sur le bouton Fork qui se situe en haut à droite de la page d'accueil du repository que vous souhaiter cloner.

Cette opération prend une poignée de secondes, et quand elle est terminée vous vous retrouvez sur la page de votre nouveau repository dénommé <votre_user>/actionaz

Coté GitHub le plus dur est fait, maintenant nous allons installer notre environnement local.

Cependant, nous n'avons détaillé que la mise en place … Au quotidien la pratique du couple Git/GitHub peut soulever des questions liées à la gestion de version. Consultez la page Utilisation de Git/GitHub au quotidien pour de obtenir plus de détail sur l'utilisation de Git.

Git (D'après : http://www.tech-juice.org/2012/05/07/setting-up-gitgithub-on-ubuntu-in-five-minutes/) :

1- Installation de git

$ sudo apt-get install git-core git-doc

2- Configuration de git

$ git config --global user.name "UserName"
$ git config --global user.email "myemail@provider.fr"

en option :

$ git config --global color.ui true

3- Génération des clés de chiffrement [Au préalable choisissez une PassPhrase, cela va vous être demandé]

$ ssh-keygen -t rsa -C "myemail@provider.fr" -f ~/.ssh/git_rsa

4- Ajouter la clé publique sur GitHub

Copier le contenu de ~/.ssh/git_rsa.pub and l'ajouter comme clé SSH dans votre profil GitHub.

5- Prise en compte de la nouvelle clé par ssh

$ ssh-add ~/.ssh/git_rsa

6- Test de connection avec GitHub

$ ssh -T git@github.com
Hi <user>! You've successfully authenticated, but GitHub does not provide shell access.

7- Prêt à cloner le 'repository'

$ git clone git@github.com:<votre user>/actionaz.git

QT et le minimum pour compiler :

1- Les packages nécessaires à la compilation

sudo apt-get install build-essential libqt4-dev qtmobility-dev libxtst-dev libnotify-dev libopencv-dev libboost-dev qtscript-tools

2- Installation de l'environnement de développement intégré QTCreator

Ce n'est pas une obligation de développer avec mais l'outil est convivial et satisfaisant alors …

sudo apt-get install qtcreator

3- Configuration de l'éditeur de qtcreator pour respecter les règles d'indentation du code

Pour le code actionaz, les indentations de début de lignes doivent être des tabulations équivalent à 4 espaces. Pour obtenir ce paramétrage dans QtCreator : Menu Outils, puis le sous-menu Options …. Dans la nouvelle fenêtre cliquer sur l'icône C++, copier la configuration par défaut et en créer une nouvelle avec le nom du projet Actionaz. Faire les réglages notamment pour obtenir les indentations souhaitées.

A faire

• Vous allez dans le répertoire contenant les sources, puis :

$ qmake -r
$ make

• Pour compiler les messages dans votre langue :

$ make locale_release

Pour traduire les chaînes de caractère du projet dans votre langue, allez à la page traduction

• Ensuite vous pouvez exécuter votre version d'actionaz

$ ./actionaz

A faire

Votre environnement de développement est prêt.

On peut maintenant s'attaquer au code source !

Les conventions de codage sont décrites ici

Autres langues pour cette page : (en)