Eliminate jstructural

Affects: io7m-com/.github#2
io7m-com · May 3, 2024 · 1f364c2 · 1f364c2
1 parent b34d21d
commit 1f364c2
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 572 deletions.
diff --git a/README.in b/README.in
@@ -0,0 +1,29 @@
+
+## ieee754b16
+
+Java functions to convert to and from the [IEEE754](https://en.wikipedia.org/wiki/IEEE_754)
+`binary16` type.
+
+## Features
+
+* Conversion between `double`/`float` and `binary16` values.
+* High coverage test suite (100%, minus an unreachable private constructor).
+* [OSGi-ready](https://www.osgi.org/)
+* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)
+* ISC license.
+
+## Usage
+
+The package uses the `char` type to store values of the `binary16` type.
+To convert a double-precision value `32.0` to `binary16` format: 
+
+```
+final char k = Binary16.packDouble(32.0);
+```
+
+To unpack values from the `binary16` format:
+
+```
+final double r = Binary16.unpackDouble(k);
+```
+
diff --git a/README.md b/README.md
@@ -13,3 +13,33 @@ ieee754b16
 | OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/ieee754b16/main.linux.temurin.lts.yml)](https://www.github.com/io7m-com/ieee754b16/actions?query=workflow%3Amain.linux.temurin.lts)|
 | OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/ieee754b16/main.windows.temurin.current.yml)](https://www.github.com/io7m-com/ieee754b16/actions?query=workflow%3Amain.windows.temurin.current)|
 | OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/ieee754b16/main.windows.temurin.lts.yml)](https://www.github.com/io7m-com/ieee754b16/actions?query=workflow%3Amain.windows.temurin.lts)|
+
+## ieee754b16
+
+Java functions to convert to and from the [IEEE754](https://en.wikipedia.org/wiki/IEEE_754)
+`binary16` type.
+
+## Features
+
+* Conversion between `double`/`float` and `binary16` values.
+* High coverage test suite (100%, minus an unreachable private constructor).
+* [OSGi-ready](https://www.osgi.org/)
+* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)
+* ISC license.
+
+## Usage
+
+The package uses the `char` type to store values of the `binary16` type.
+To convert a double-precision value `32.0` to `binary16` format: 
+
+```
+final char k = Binary16.packDouble(32.0);
+```
+
+To unpack values from the `binary16` format:
+
+```
+final double r = Binary16.unpackDouble(k);
+```
+
+
diff --git a/com.io7m.ieee754b16.documentation/pom.xml b/com.io7m.ieee754b16.documentation/pom.xml
diff --git a/com.io7m.ieee754b16.documentation/src/main/assembly/documentation.xml b/com.io7m.ieee754b16.documentation/src/main/assembly/documentation.xml
diff --git a/...e754b16.documentation/src/main/java/com/io7m/ieee754b16/documentation/IDocumentation.java b/...e754b16.documentation/src/main/java/com/io7m/ieee754b16/documentation/IDocumentation.java
diff --git a/...eee754b16.documentation/src/main/java/com/io7m/ieee754b16/documentation/package-info.java b/...eee754b16.documentation/src/main/java/com/io7m/ieee754b16/documentation/package-info.java