Développeur how-to

A simple page to explain how-to start developping within DruideCave.



Ant

Ant is a build tool used by Druide Cave in order to compile and create JARs.

You can download it from here : http://ant.apache.org/bindownload.cgi

Any version at least 1.6 will be OK.

Just untar the downloaded file and place it in the directory of your choice, let's say c:\dev\apache-ant-1.6.5 for windows user or /usr/local/apache-ant-1.6.5 for Linux guys.

You have to add in your environnement variables 2 things :

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

In order to do it just open your System property window (rigth click on "Workstation -> Properties") and choose the "Advance" tab. Once here, clisk on the "Environnement Variables" button.

Then you have to click on the "New" button and add :

Name : ANT_HOME

Value : c:\dev\apache-ant-1.6.5

 

  • in your path : c:\dev\apache-ant-1.6.5\bin

In order to do it just open your System property window (rigth click on "Workstation -> Properties") and choose the "Advance" tab. Once here, clisk on the "Environnement Variables" button.

Find the Path variable and click on the "Modify" button and add at the end of the value line :

Value : ...EXISTING PARAMETERS...;c:\dev\apache-ant-1.6.5\bin

 

Once this is done you can open a command line ant type in "ant".

Example :

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


That's all folks:) 



Subversion (surname's SVN)


Subversion is a source repository very usefull in order to share sources files between several developpers.

DruideCave source repository can be found here (URL SVN) :

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

A standart structure is set :

trunck -> Main development branche

branches -> Some branches... not used yet

tags -> Keep a trace on release or flag a dev state

To get all the sources - it's called a Check Out - your favorite IDE (IntelliJ Idea, Eclipse, Netbeans, ...) will succeed easely with Subversion, just configure it with the DruideCave SVN URL written above.

If you modified some sources and want to put back your modified sources into the repository - it's called a commit - you have to be a registered developper on the DruideCave project (ask me) or you'll have to send me the changes so I'll do it for you.

Warning :

As Subversion is a way to share source, we don't want anything to be erased or lost so some rules MUST be clear :

  1. Always update your sources before commiting your modifications,
  2. If there is a conflict between your sources and the repository's ones and you doubt about what to do : ask me,
  3. Whatever the case, if you doubt, ask me... please :) 



Codding

One day... :)


Compile and launch the project

Just open a command line (console) at the DruideCave project's root directory and call the command :

ant compile -> Compiles the project

ant jar -> Compiles and create the executable JAR

ant go -> Compiles, create the executable JAR and launchs DruideCave

 

If something's missing or not clear enough -> Contact me : http://sourceforge.net/users/eldruidos/