Guide du développeur

Une page pour expliquer aux développeurs comment démarrer avec DruideCave.



Ant

Ant est un outil de build qui permet dans le cadre de DruideCave de compiler et de créer le JARs permettant l'éxécution de DruideCave.

Téléchargez Ant à partir de cette page : http://ant.apache.org/bindownload.cgi

N'importe quelle version à partir de la 1.6 fera l'affaire.

Décompressez l'archive téléchargée dans un répertoire de votre choix, disons c:\dev\apache-ant-1.6.5 (/usr/local/apache-ant-1.6.5 pour les utilisateurs de Linux) par exemple.

Il faut ajouter dans vos variables d'environnement 2 choses :

  • ANT_HOME = c:\dev\apache-ant-1.6.5

Pour faire ça il faut sous windows aller dans le panneau des Propriétés Système (Click droit sur "Poste de travail -> Propriété") puis choisir l'onglet "Avancé" et là cliquez sur le bouton "Variables d'environnements".

A ce stade il faut cliquer sur le bouton "Nouveau" et ajouter :

Nom de la variable : ANT_HOME

Valeur de la variable : c:\dev\apache-ant-1.6.5

 

  • dans votre path : c:\dev\apache-ant-1.6.5\bin

Pour faire ça il faut sous windows aller dans le panneau des Propriétés Système (Click droit sur "Poste de travail -> Propriété") puis choisir l'onglet "Avancé" et là cliquez sur le bouton "Variables d'environnements".

A ce stade il faut trouver Path et cliquer sur le bouton "Modifier" et ajouter à la fin de la ligne de la valeur de la variable :

Valeur de la variable : ...EXISTING PARAMETERS...;c:\dev\apache-ant-1.6.5\bin

 

Ensuite il vous suffit de taper "ant" dans une ligne de commande et cela devrait fonctionner correctement.

Exemple :

[ledruide@mercure] # ant -version
Apache Ant version 1.6.5 compiled on June 2 2005


Et le tour est joué :)

 


Subversion (de son petit nom SVN)

Subversion est un référentiel de source qui permet à plusieurs développeur de partager les fichiers source afin de collaborer efficacement sur un projet.

Le référentiel des sources de DruideCave se trouve ici (URL SVN) :

https://druidecave.svn.sourceforge.net/svnroot/druidecave

Une structure classique est en place :

trunck -> Branche de développement principale

branches -> Des branches de développement... pas utilisée pour l'instant

tags -> Pour garder une trace de chaque release... ou pour tagger un état de dev.

 

Pour récupérer les sources - on appelle ça un Check Out - plusieurs choix s'offrent à vous. Votre IDE (IntelliJ Idea, Eclipse, Netbeans, ...) doit probablement savoir gérer Subversion, il suffit de le configurer en lui fournissant l'URL SVN indiquée plus haut.

Si vous êtes à l'origine d'une ou de plusieurs modification et que vous souhaitez modifier le référentiel SVN des sources - on appelle ça un commit - il vous faut être enregistré comme développeur sur le projet ou me faire parvenir vos modification et je le ferai pour vous.

Avertissement :

Comme Subversion permet à plusieurs personnes de travailler simultanément sur un projet, certaine règles sont à respecter :

  1. Toujours faire un update avant de commiter quoi que ce soit,
  2. S'il y a un conflit entre vos sources et celles de SVN et que vous n'êtes pas sûr de vous : Demandez-moi quoi faire,
  3. Dans tous les cas si vous hésitez, demandez-moi ;)

 



Normes de codage

A rédiger :)


Compiler et lancer le projet

Il suffit de se positionner en ligne de commande à la racine du répertoire de développement de DruideCave et d'appeler la commande :

ant compile -> Permet de compiler le projet

ant jar -> Permet de compiler et de créer le Jar final

ant go -> Permet de compiler, de créer le Jar final et de l'éxécuter

 

S'il un point est manquant ou insuffisement clair -> Contactez-moi : http://sourceforge.net/users/eldruidos/