Mark 3.0.0-SNAPSHOT, update site docs, README.

.github/workflows/run-with-xvfb.sh

@@ -0,0 +1,66 @@
+#!/bin/bash -ex
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#
+
+exec > >(tee build.txt) 2>&1
+
+#---------------------------------------------------------------------
+# Install all of the various required packages.
+#
+# We use:
+#   xvfb    to provide a virtual X server
+#   fluxbox to provide a bare-minimum window manager with click-to-focus
+#   ffmpeg  to record the session
+#   feh     to set a background
+#
+
+sudo apt-get -y update
+sudo apt-get -y upgrade
+sudo apt-get -y install xvfb fluxbox feh ffmpeg
+
+#---------------------------------------------------------------------
+# Start Xvfb on a new display.
+#
+
+Xvfb :99 &
+export DISPLAY=:99
+sleep 1
+
+#---------------------------------------------------------------------
+# Start recording the session.
+#
+
+ffmpeg -f x11grab -y -r 60 -video_size 1280x1024 -i :99 -vcodec vp9 test-suite.webm &
+FFMPEG_PID="$!"
+
+#---------------------------------------------------------------------
+# Start fluxbox on the X server.
+#
+
+fluxbox &
+sleep 1
+
+#---------------------------------------------------------------------
+# Set a desktop image.
+#
+
+feh --bg-tile .github/workflows/wallpaper.png
+sleep 1
+
+#---------------------------------------------------------------------
+# Execute the passed-in build command.
+#
+
+"$@"
+
+#---------------------------------------------------------------------
+# Wait a while, and then instruct ffmpeg to stop recording. This step
+# is necessary because video files need to be processed when recording
+# stops.
+#
+
+sleep 20
+kill -INT "${FFMPEG_PID}" || true

README.in

@@ -6,7 +6,9 @@ hash function.
 
 ## Features
 
-* Murmur3 hash function.
+* 32-bit and 64-bit versions of the
+  [MurmurHash3](https://en.wikipedia.org/wiki/MurmurHash) non-cryptographic
+  hash function.
 * High coverage test suite.
 * [OSGi-ready](https://www.osgi.org/)
 * [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)

README.md

@@ -22,7 +22,9 @@ hash function.
 
 ## Features
 
-* Murmur3 hash function.
+* 32-bit and 64-bit versions of the
+  [MurmurHash3](https://en.wikipedia.org/wiki/MurmurHash) non-cryptographic
+  hash function.
 * High coverage test suite.
 * [OSGi-ready](https://www.osgi.org/)
 * [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)

com.io7m.jmurmur.core/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <groupId>com.io7m.jmurmur</groupId>
     <artifactId>com.io7m.jmurmur</artifactId>
-    <version>2.0.1-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
   </parent>
   <artifactId>com.io7m.jmurmur.core</artifactId>
 

com.io7m.jmurmur.tests/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <groupId>com.io7m.jmurmur</groupId>
     <artifactId>com.io7m.jmurmur</artifactId>
-    <version>2.0.1-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
   </parent>
   <artifactId>com.io7m.jmurmur.tests</artifactId>
 

pom.xml

@@ -15,7 +15,7 @@
 
   <groupId>com.io7m.jmurmur</groupId>
   <artifactId>com.io7m.jmurmur</artifactId>
-  <version>2.0.1-SNAPSHOT</version>
+  <version>3.0.0-SNAPSHOT</version>
 
   <packaging>pom</packaging>
   <name>com.io7m.jmurmur</name>
@@ -28,6 +28,7 @@
   </modules>
 
   <properties>
+    <!-- Configuration. -->
     <io7m.api.previousVersion>2.0.0</io7m.api.previousVersion>
     <io7m.java.targetJavaVersion>21</io7m.java.targetJavaVersion>
   </properties>

src/site/resources/documentation.xml

@@ -2,8 +2,7 @@
 
 <div xmlns="http://www.w3.org/1999/xhtml">
   <h3>User documentation</h3>
-  <ul>
-    <li><a href="documentation/index-m.xhtml">XHTML - one page per section</a></li>
-    <li><a href="documentation/index.xhtml">XHTML - single page</a></li>
-  </ul>
+  <p>
+    See the <a href="https://www.github.com/io7m/jmurmur/README.md">README</a>.
+  </p>
 </div>

src/site/resources/features.xml

@@ -2,9 +2,18 @@
 
 <div xmlns="http://www.w3.org/1999/xhtml">
   <ul>
-    <li>100% automated unit test coverage</li>
-    <li><a href="https://www.osgi.org/">OSGi</a>-ready</li>
-    <li><a href="https://en.wikipedia.org/wiki/Java_Platform_Module_System">JPMS</a>-ready</li>
+    <li>
+      32-bit and 64-bit versions of the
+      <a href="https://en.wikipedia.org/wiki/MurmurHash">MurmurHash3</a>
+      non-cryptographic hash function.
+    </li>
+    <li>High coverage automated test suite.</li>
+    <li>
+      <a href="https://www.osgi.org/">OSGi</a>-ready.
+    </li>
+    <li>
+      <a href="https://en.wikipedia.org/wiki/Java_Platform_Module_System">JPMS</a>-ready.
+    </li>
     <li>ISC license</li>
   </ul>
 </div>