Welcome to this developer guide!

Developing on the GroIMP source code only require a java compiler. Additionally GroIMP support two development setup: Maven and Eclipse.

1. (Optional) Forking the official repository to an own one. This is done to be able to commit and push changes.
2. (Optional) Mirroring the fork repository to the official one. This merges updates of the official repository to the fork repository automatically.
3. Cloning the fork repository to the local computer (in Eclipse)

Go to https://gitlab.com/grogra/groimp in your internet browser.

Click on the Fork button of the repository.

Select your own gitlab namespace and optionally an other project name (not recommended).

Change or reuse the project slug and description.

Click on Fork project.

In an internet browser, go to your own repository that forks the official one.

On the side bar, click on Settings > Repository.

Expand the category `Mirroring repositories`.

Insert the URL of the official repository: https://gitlab.com/grogra/groimp

Click on Mirror repository

Note: the two previous steps are optionals for users, but highly recommended if you plan on contributing to the code.

This method do not require any Gitlab account.

It is possible to simply download the directory of source code from GitLab on the main page https://gitlab.com/grogra/groimp. There is a download arrow button right next to the _clone_ button.

You can then download the whole repository as any archive format you like.

Once it is downloaded, extract the archive to the directory where you want to setup your eclipse workspace.

You still need to import the repository in Eclipse. See two section bellow.

You can clone a repository from GitLab with the command line:

git clone  https://gitlab.com/grogra/groimp.git

This will create a directory named groimp and download all the remote content in it.

You still need to import the repository in Eclipse. See the section bellow.

You have the repository with GroIMP source code on your local device.

In Eclipse, click on File > Import…

Open the category `Maven`.

Select `Existing Maven Projects`.

Set the Root Directory as the groimp repository you downloaded.

All GroIMP plugins should appear in the projects list.

Click on `Finish`.

Warning: This method sometime lead to error in the code compilation. It is not recommended to use it.

The git repository can be imported in Eclipse using the eclipse plugin eGit, which is embedded by default in all Eclipse installations.

Click on File > Import…

Open the category `Git`

Select Projects from Git

Select `Clone URI`

Insert `git@gitlab.com:yourgitlabprefix/groimp.git` into the URI field and replace the prefix with your prefix where to find the forked repository.

See the guide on how to setup your Eclipse environment here.