Outils pour utilisateurs

Outils du site


fr:devel

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

fr:devel [2016/10/09 09:10]
fr:devel [2020/02/09 13:26] (Version actuelle)
Ligne 1: Ligne 1:
 +
 +====== Développer et Contribuer ======
 +
 +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.
 +
 +====== Description de l'​environnement de développement ======
 +
 +Les sources d'​Actionaz sont stockées sur [[https://​github.com/​Jmgr/​actionaz/​network|GitHub]]
 +
 +Une des premières taches va être de cloner le '​repository'​
 +
 +Puis de configurer votre environnement de développement local.
 +
 +----
 +
 +===== Configuration GitHub =====
 +
 +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 [[fr:​devel:​Git/​GitHub|Utilisation de Git/GitHub au quotidien]] pour de obtenir plus de détail sur l'​utilisation de **Git**.
 +
 +----
 +
 +===== Environnement Local =====
 +
 +==== Cas: Ubuntu ====
 +
 +**Git** (D'​après : [[http://​www.tech-juice.org/​2012/​05/​07/​setting-up-gitgithub-on-ubuntu-in-five-minutes/​]]) :
 +
 +1- Installation de git
 +<code bash>
 +$ sudo apt-get install git-core git-doc
 +</​code>​
 +
 +2- Configuration de git
 +<code bash>
 +$ git config --global user.name "​UserName"​
 +$ git config --global user.email "​myemail@provider.fr"​
 +</​code>​
 +
 +en option : 
 +<code bash>
 +$ git config --global color.ui true
 +</​code>​
 +
 +3- Génération des clés de chiffrement [Au préalable choisissez une PassPhrase, cela va vous être demandé]
 +<code bash>
 +$ ssh-keygen -t rsa -C "​myemail@provider.fr"​ -f ~/​.ssh/​git_rsa
 +</​code>​
 +
 +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
 +<code bash>
 +$ ssh-add ~/​.ssh/​git_rsa
 +</​code>​
 +
 +6- Test de connection avec GitHub
 +<code bash>
 +$ ssh -T git@github.com
 +Hi <​user>​! You've successfully authenticated,​ but GitHub does not provide shell access.
 +</​code>​
 +
 +7- Prêt à cloner le '​repository'​
 +<code bash>
 +$ git clone git@github.com:<​votre user>/​actionaz.git
 +</​code>​
 +
 +----
 +**QT et le minimum pour compiler :**
 +
 +<note warning>​Il peut y avoir doublon avec la page [[fr:​compilation|compilation]]</​note>​
 +
 +1- Les packages nécessaires à la compilation
 +
 +<code bash>
 +sudo apt-get install build-essential libqt4-dev qtmobility-dev libxtst-dev libnotify-dev libopencv-dev libboost-dev qtscript-tools
 +</​code>​
 +
 +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 ...
 +<code bash>
 +sudo apt-get install qtcreator
 +</​code>​
 +
 +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.
 +
 +{{ :​wiki:​qtcreator-config.png?​300 |}}
 +
 +
 +
 +
 +==== Cas: Windows ====
 +A faire
 +
 +----
 +
 +===== Comment Compiler ? =====
 +
 +==== Cas Ubuntu ====
 +
 +  * Vous allez dans le répertoire contenant les sources, puis :
 +<code bash>
 +$ qmake -r
 +$ make
 +</​code>​
 +  * Pour compiler les messages dans votre langue :
 +<code bash>
 +$ make locale_release
 +</​code>​
 +Pour traduire les chaînes de caractère du projet dans votre langue, allez à la page [[fr:​devel:​translate|traduction]]
 +  * Ensuite vous pouvez exécuter votre version d'​actionaz
 +<code bash>
 +$ ./actionaz
 +</​code>​
 +
 +==== Cas Windows ====
 +
 +A faire
 +
 +----
 +
 +===== On va voir les sources ? =====
 +
 +Votre environnement de développement est prêt. ​
 +
 +On peut maintenant s'​attaquer au [[fr:​devel:​code_source|code source]] !
 +
 +Les conventions de codage sont décrites [[fr:​devel:​coding-style|ici]]
 +
 +----
 +
 +Autres langues pour cette page : [[en:​devel|(en)]]
 +
 +
 +
 +
 +
 +
 +