Differences

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

--- maintainer-guide:making-a-groimp-maven [2024/04/15 11:23] – created gaetan
+++ maintainer-guide:making-a-groimp-maven [2024/12/18 10:55] (current) – gaetan
@@ Line 1: / Line 1: @@
 ===== Compile a GroIMP plugin =====
+==== Requirements ====
+To compile GroIMP you will need the following additional tools:
+  * [[https://maven.apache.org/install.html|Maven]]
+  * [[https://www.oracle.com/java/technologies/downloads/|Java 17]] or newer
+  * [[https://www.perl.org/get.html|Perl]]
 It is possible to compile and package one specific plugin. The plugin have to follow the template of [[https://gitlab.com/grogra/groimp-template/newplugin-maven|new plugin]].
@@ Line 10: / Line 17: @@
 Then, the plugin can be compiled with ''mvn compile'', or package with ''mvn package''. The packaging create a repository at ../app/plugin/NAME_OF_YOUR_PLUGIN based on the root of the plugin. This repository can be added to an existing installation of GroIMP by simple copy paste.
+==== Compile with help panels ====
+The documentation inside GroIMP is written in docbook which can be compiled into the html layout seen in the help panel.
+To do this compilation an installation of docbook, docbook-xsl and xsltproc  is required.
+On a Debian based system these can be installed with the following command:
+''sudo apt install xsltproc docbook docbook-xsl''
+This require to have ''pandoc'' version > 3.3 installed on your device.
+Afterwards the maven command: ''mvn package -P app-with-doc'' can be executed.
 ===== Compile the complete project: =====
@@ Line 41: / Line 61: @@
 A specific distribution can be selected with ''mvn package -P release-win'' ''mvn package -P release-deb'', or ''mvn package -P release-macos'' to create a single executable.
+See more:
+  * [[:dev-guide:maven-commands|List of useful Maven commands]]
 ===== Deploy the release files online =====