This is an automated email from the ASF dual-hosted git repository.
mawiesne pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opennlp-site.git
The following commit(s) were added to refs/heads/main by this push:
new 7a592d56 Modernizes building.ad, improving structure, introducing TOC,
improving formatting
7a592d56 is described below
commit 7a592d56342b4f059f2d874ed7e5e80cc6bef07e
Author: Martin Wiesner <[email protected]>
AuthorDate: Sun Nov 17 13:52:48 2024 +0100
Modernizes building.ad, improving structure, introducing TOC, improving
formatting
---
src/main/jbake/content/building.ad | 45 +++++++++++++++++++++++---------------
1 file changed, 27 insertions(+), 18 deletions(-)
diff --git a/src/main/jbake/content/building.ad
b/src/main/jbake/content/building.ad
index 7872ce82..08402318 100644
--- a/src/main/jbake/content/building.ad
+++ b/src/main/jbake/content/building.ad
@@ -21,29 +21,29 @@
:jbake-tags: building, source
:jbake-status: published
:idprefix:
+:toc:
+:toc-title: Content
-## Last Official
+== Prerequisites
-### Prerequisites
+ - If you have an IDE installed such as
link:https://netbeans.org/[NetBeans,window=_blank] or
link:https://www.eclipse.org/[Eclipse,window=_blank] installed,
+ it will make your development easier. However, follow on for the brave.
- - If you have an IDE installed such as
https://netbeans.org/[NetBeans,window=_blank] or
https://www.eclipse.org/[Eclipse,window=_blank] installed,
- it will make your development easier. However, follow on for the brave.
-
- - At least
https://www.oracle.com/technetwork/java/javase/overview/index.html[JDK
17,window=_blank] is required to compile and run
+ - At least link:https://adoptium.net/de/temurin/releases/?version=17[JDK
17,window=_blank] is required to compile and run
the object code.
- - At least https://maven.apache.org/[Apache Maven 3.3.9,window=_blank] is
required to build the source
- files and assemble the project.
+ - At least link:https://maven.apache.org/download.cgi[Apache Maven
3.3.9,window=_blank] is required to build the source
+ files and assemble the project. More recent versions are fully supported.
-### Build Procedure
+== Build Procedure
OpenNLP can either be build from the distributed sources or from
-a subversion checkout. These build instructions document how
-to build from the latest trunk version. The distributed source package
+a checkout of the git repository. These build instructions document how
+to build from the latest version of the _main_ branch. The distributed source
package
includes a README file which explains how to build it.
On the first checkout everything should be built.
-Go to the opennlp folder inside the trunk folder (e.g. opennlp-trunk) and type
+Go to the opennlp folder inside the main branch and type
-----
cd opennlp
@@ -51,24 +51,33 @@ mvn install
-----
to build all modules.
-The build installs the maven artifacts in the local repository
-and creates a binary and source distribution inside the
-opennlp-distr/target folder.
+
+The build installs the Maven artifacts in the local repository
+and creates a binary and source distribution inside the
+``opennlp-distr/target`` folder.
After the initial build the individual modules can be built on their own
with: ``mvn install``
-In the opennlp-docs project it is
+In the opennlp-docs folder it is
recommended to always build with ``mvn clean install`` because
changed docbook xml files might not be re-processed otherwise.
+=== Skipping Tests
+
In some cases it might be convenient to skip the tests.
That can be done with the ``-Dmaven.test.skip=true`` option.
-For example type: ``mvn clean install -Dmaven.test.skip=true``
+In this case, just execute:
+
+-----
+mvn clean install -Dmaven.test.skip=true
+-----
No tests will be executed.
-It might happen from time to time that the build fails,
+=== Reporting Problems
+
+NOTE: It might happen from time to time that the build fails,
if so please report a broken build on the _opennlp-dev_
mailto:[email protected][mailing
list]. The build should always work for everyone.
