GroIMP wiki

a part of grogra.de

User Tools

Site Tools

Trace: • leaf-triangulation • linking-help-button • create-groimp-plugin • sensor-grids • xl-queries-and-operators
dev-guide:developer-guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
dev-guide:developer-guide [2024/06/25 10:18] – gaetandev-guide:developer-guide [2024/06/25 11:19] (current) – [Cloning the repository] gaetan
Line 8: Line 8:
  
   - Installing **Eclipse**. This can be skipped if it is already installed.   - Installing **Eclipse**. This can be skipped if it is already installed.
-  - (Optional) **Forking** the official repository to an own one. This is done to be able to commit and push changes. 
-  - (Optional) **Mirroring** the fork repository to the official one. This merges updates of the official repository to the fork repository automatically. 
   - **Cloning** the fork repository to the local computer (in Eclipse)   - **Cloning** the fork repository to the local computer (in Eclipse)
   - Adjusting the **compiler** and **Java version**   - Adjusting the **compiler** and **Java version**
Line 69: Line 67:
  
  
-==== (Optional) Forking the repository ====+==== Cloning the repository ====
  
-Go to [[https://gitlab.com/grogra/groimp]] in your internet browser.+It is possible (and recommended) to clone the git repository without Eclipse. More information [[:dev-guide:getting-started|there]].
  
-Click on the //Fork// button of the repository.+=== From Eclipse egit ===
  
-Select your own gitlab namespace and optionally an other project name (not recommended).+**Warning: This method sometime lead to error in the code compilation. It is not recommended to use it.** 
  
-Change or reuse the project slug and description.+The git repository can be imported in Eclipse using the eclipse plugin eGit, which is embedded by default in all Eclipse installations.
  
-Click on //Fork project//. +Click on File > Import…
- +
-==== (Optional) Mirroring the repository ==== +
- +
-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.** +
- +
-==== Cloning the repository ==== +
- +
-=== In Eclipse === +
- +
-Click on //File// > //Import...//+
  
 Open the category `Git` Open the category `Git`
  
-Select //Projects from Git// +Select Projects from Git
- +
-Click on //Next > //+
  
 Select `Clone URI` Select `Clone URI`
  
-Click //Next > //+Insert `git@gitlab.com:yourgitlabprefix/groimp.git` into the URI field and replace the prefix with your prefix where to find the forked repository.
  
-Insert `git@gitlab.com:yourgitlabprefix/groimp.git` into the URI field and replace the prefix with your prefix where to find the  
-forked repository 
  
-The other fields are automatically set. +==== Import the repository in Eclipse ====
- +
-Click on //Next > // +
- +
-The key information is shown now. +
- +
-Select the checkbox `Accept and store this key, and continue connecting?` +
- +
-Click on //OK<// +
- +
-Now, the branch selection window appears. +
- +
-All branches should be selected. +
- +
-Click on //Next > // +
- +
-Set the local path to the repository. It should be in your user directory in the subdirectory `/home/username/git/groimp/`. +
- +
-Click on //Next > // +
- +
-This may take much time since the repository is very large (800 MB). +
- +
-In the resulting window, click //Next > // +
- +
-In the next window, all subprojects must be selected. +
- +
-Click on //Finish// +
- +
-Wait until it has been built. +
- +
-The repository is imported as a long list of projects. +
- +
-The repository is imported in Ecplise and you can go to setting Eclipse up. +
- +
-=== From GitLab === +
- +
-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.  +
- +
-=== From a bash command === +
- +
-You can clone a repository from GitLab with the command line:  +
- +
-<code> +
-git clone  https://gitlab.com/grogra/groimp.git +
-</code> +
- +
-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.  +
- +
-=== Import the repository in Eclipse ===+
  
 You have the repository with GroIMP source code on your local device.  You have the repository with GroIMP source code on your local device. 
Line 187: Line 103:
  
 Click on `Finish`. Click on `Finish`.
- 
  
 ==== Setting up Java Runtime Environment ==== ==== Setting up Java Runtime Environment ====
dev-guide/developer-guide.1719303493.txt.gz · Last modified: 2024/06/25 10:18 by gaetan