Skip to content

Contribute Core Eoulsan

Laurent Jourdren edited this page Mar 2, 2016 · 4 revisions

Eoulsan use the Git as distributed revision control system for its code source. The main repository is on GitHub.

Get a copy of the Eoulsan repository

You can get a local copy of the eoulsan repository with this command:

$ git clone https://github.com/GenomicParisCentre/eoulsan.git

Creating Eclipse project files

As Eoulsan use Maven build automation tool, you can easily create eclipse project files if you use this IDE to develop. Of course you can use any other IDE or editor for contributing to Eoulsan.

$ mvn eclipse:eclipse  -DdownloadSources=true -DdownloadJavadocs=true

A warning message may appear if some source or javadoc dependencies cannot be found. To import the Eoulsan project in Eclipse, go to File > Import... > General > Existing projects into Workspace and select the root directory of the eoulsan project. By clicking on the finish button, eoulsan will be imported into Eclipse workspace.

Compiling

First set your current directory to the base directory of Eoulsan.

  • To build both source and binary distribution:
$ mvn install
  • To generate documentation:
$ mvn site
  • To generate distributions and documentation:
$ mvn site install
  • To clean the build directories:
$ mvn clean

Pushing changes to Google Code repository

To push your changes on Eoulsan code use the following command:

$ git push origin master