This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch geoapi-4.0
in repository https://gitbox.apache.org/repos/asf/sis.git
The following commit(s) were added to refs/heads/geoapi-4.0 by this push:
new f75f7ee3a5 Add or edit `README.md` files.
f75f7ee3a5 is described below
commit f75f7ee3a58087159dc8089033e1af413fb4e229
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Sun Oct 1 15:31:40 2023 +0200
Add or edit `README.md` files.
---
README.md | 9 +++++++
endorsed/README.md | 15 +++++++++++
.../sis/referencing/report/HTMLGenerator.java | 2 +-
incubator/README.md | 10 ++++++++
optional/README.md | 29 ++++++++++++++++++++++
optional/src/org.apache.sis.gui/bundle/README | 7 ++++--
optional/src/org.apache.sis.gui/bundle/lib/README | 1 +
7 files changed, 70 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index e9919f5c0b..eeb59ac67d 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,15 @@ For publishing to the local `~/.m2` repository
gradle publishToMavenLocal
+### Build the graphical application
+
+If the [optional modules](optional/README.md) prerequisites are met,
+a ZIP file containing a subset of Apache SIS modules and dependencies
+is automatically built in the `optional/build/bundle/` sub-directory.
+That ZIP file can be unzipped in any directory and the application is
+launched by running the `./bin/sisfx` script.
+
+
## Getting Started
Information for running a [command-line
tool](https://sis.apache.org/command-line.html)
diff --git a/endorsed/README.md b/endorsed/README.md
new file mode 100644
index 0000000000..47b0adcf52
--- /dev/null
+++ b/endorsed/README.md
@@ -0,0 +1,15 @@
+# Endorsed modules of Apache SIS
+
+The `src` sub-directory contains modules included in Apache SIS releases.
+Those modules have no prerequisites other than Java Development Kit (JDK)
+and Gradle for building from the sources. The build command is:
+
+ gradle assemble
+
+The JAR files will be in the `build/libs/` directory.
+See [the parent directory](../README.md) for more information.
+
+## See also
+The [optional](../optional) directory contains modules that are also part
+of Apache SIS releases, but requiring prerequisites such as acceptance of
+license agreements more restrictive than Apache 2 license.
diff --git
a/endorsed/src/org.apache.sis.referencing/test/org/apache/sis/referencing/report/HTMLGenerator.java
b/endorsed/src/org.apache.sis.referencing/test/org/apache/sis/referencing/report/HTMLGenerator.java
index 6637e54659..1e2d928fe7 100644
---
a/endorsed/src/org.apache.sis.referencing/test/org/apache/sis/referencing/report/HTMLGenerator.java
+++
b/endorsed/src/org.apache.sis.referencing/test/org/apache/sis/referencing/report/HTMLGenerator.java
@@ -32,7 +32,7 @@ import org.apache.sis.util.internal.Constants;
/**
- * Base class of all classes used to generate HTML pages to be published on
+ * Base class of some classes used to generate HTML pages to be published on
* the <a href="https://sis.apache.org/";>https://sis.apache.org/</a> web site.
*
* <p>This class creates files in the current default directory. It is user's
responsibility
diff --git a/incubator/README.md b/incubator/README.md
new file mode 100644
index 0000000000..66b205a5be
--- /dev/null
+++ b/incubator/README.md
@@ -0,0 +1,10 @@
+# Incubator modules of Apache SIS
+
+The `src` sub-directory contains experimental modules that are not yet
included in
+Apache SIS releases. Those JAR files are not deployed on Maven Central
repository.
+Using the JAR files requires compiling the `main` branch from the sources:
+
+ gradle assemble
+
+The JAR files will be in the `build/libs/` directory. Their API may change
without
+warning at any time, until the modules move to the [endorsed](../endorsed)
directory.
diff --git a/optional/README.md b/optional/README.md
new file mode 100644
index 0000000000..87b33e8562
--- /dev/null
+++ b/optional/README.md
@@ -0,0 +1,29 @@
+# Optional modules of Apache SIS
+
+The `src` sub-directory contains modules included in Apache SIS releases,
+but which are buildable or executable only if some dependencies are added
+by the users themselves. Those dependencies are not distributed with Apache
+SIS releases because they are under more restrictive licenses than Apache 2.
+If those dependencies are not provided, Apache SIS [endorsed](../endorsed)
+modules will still work but without Graphical User Interface (GUI).
+
+## Configuration
+
+Paths to dependencies are specified by the following environment variables.
+After those variables are set, `gradle assemble` can be executed as usual.
+
+### JavaFX
+
+JavaFX is licensed under GPL with classpath exception. The JavaFX SDK can be
+downloaded from the [OpenJFX web site](https://openjfx.io/) and installed in
+any directory. The path to the directory containing the JAR files is specified
+in Unix shell as below (change the `/usr/lib/jvm/openjfx` path as needed):
+
+ export PATH_TO_FX=/usr/lib/jvm/openjfx
+
+
+## Running the JavaFX application
+
+A ZIP file containing a subset of Apache SIS modules and dependencies is built
+in the `build/bundle/` sub-directory. That ZIP file can be unzipped in any
directory.
+The application is launched by running the `./bin/sisfx` script.
diff --git a/optional/src/org.apache.sis.gui/bundle/README
b/optional/src/org.apache.sis.gui/bundle/README
index 113570835a..b93a37074b 100644
--- a/optional/src/org.apache.sis.gui/bundle/README
+++ b/optional/src/org.apache.sis.gui/bundle/README
@@ -18,8 +18,11 @@ the only requirement is Java 11 or later. For launching the
desktop application,
requirements are Java 16 or later and JavaFX 13 or later.
1) Unzip `apache-sis-1.4-bin.zip` in any directory.
-2) Add the `apache-sis-1.4/bin` directory to the path.
-3) Invoke `sis` or `sisfx` on the command line.
+2) Invoke `./apache-sis-1.4/bin/sis` for the command-line.
+3) Invoke `./apache-sis-1.4/bin/sisfx` for the graphical application.
+
+The `apache-sis-1.4/bin` directory may also be added to the `PATH` environment
+variable for making `sis` or `sisfx` invocations easier.
Configuration (Unix only)
diff --git a/optional/src/org.apache.sis.gui/bundle/lib/README
b/optional/src/org.apache.sis.gui/bundle/lib/README
index db5e0b1adf..06f10db15d 100644
--- a/optional/src/org.apache.sis.gui/bundle/lib/README
+++ b/optional/src/org.apache.sis.gui/bundle/lib/README
@@ -1,4 +1,5 @@
This directory contains Apache SIS files together with dependencies.
+Some optional dependencies need to be added by users if desired.
- Derby database
- JAXB API
