diff --git a/com.io7m.laurel.distribution/src/main/assembly/distribution.xml b/com.io7m.laurel.distribution/src/main/assembly/distribution.xml index 54e8464..3e20d75 100644 --- a/com.io7m.laurel.distribution/src/main/assembly/distribution.xml +++ b/com.io7m.laurel.distribution/src/main/assembly/distribution.xml @@ -7,7 +7,7 @@ distribution - ${project.name}-${project.version} + laurel zip diff --git a/com.io7m.laurel.documentation/src/main/resources/com/io7m/laurel/documentation/document.css b/com.io7m.laurel.documentation/src/main/resources/com/io7m/laurel/documentation/document.css index aefe446..1ec13fb 100644 --- a/com.io7m.laurel.documentation/src/main/resources/com/io7m/laurel/documentation/document.css +++ b/com.io7m.laurel.documentation/src/main/resources/com/io7m/laurel/documentation/document.css @@ -30,6 +30,7 @@ .class, .command, .constant, +.directory, .element, .expression, .file, diff --git a/com.io7m.laurel.documentation/src/main/resources/com/io7m/laurel/documentation/install.xml b/com.io7m.laurel.documentation/src/main/resources/com/io7m/laurel/documentation/install.xml index 82c9f53..f17a5e2 100644 --- a/com.io7m.laurel.documentation/src/main/resources/com/io7m/laurel/documentation/install.xml +++ b/com.io7m.laurel.documentation/src/main/resources/com/io7m/laurel/documentation/install.xml @@ -5,8 +5,81 @@ - Installation… + There are several ways to install the Laurel application. + + + The portable application distribution is simply a zip archive consisting of a couple of frontend shell scripts and + the Java jar files that comprise the application. This distribution is mostly platform-independent + , but requires some (fairly straightforward) + manual setup. + + + The distribution uses your locally installed Java VM. First, check that you have a JDK 21 or higher JVM installed: + + + + + + The application distribution is a zip file with a laurel directory in the root of + the zip archive. + + + + + + On UNIX-like platforms, ensure the included frontend scripts are executable: + + + + + + Set the LAUREL_HOME environment variable to the directory: + + + + + + Now run either laurel/bin/laurel for the command-line tool, or + laurel/bin/laurel-ui + for the graphical user interface. + + + + + + + + Unfortunately, JavaFX does not allow for platform-independence due to including rather incompetently-packaged + platform-specific artifacts. The command-line tools are usable on the fairly huge range of underlying platforms + that the sqlite-jdbc library supports. + +