WIP

Author: Bergmann89

Cargo.lock

@@ -4,13 +4,17 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-anyhow = "1.0.99"
-arrayvec = "0.7.6"
-bitflags = "2.9.1"
-color_space = "0.5.4"
-crc = "3.3.0"
-hidapi = "2.6.3"
-thiserror = "2.0.14"
+anyhow = "1.0"
+arrayvec = "0.7"
+bitflags = "2.9"
+color_space = "0.5"
+crc = "3.3"
+hidapi = "2.6"
+thiserror = "2.0"
+
+[build-dependencies]
+base64 = "0.22"
+regex = "1.11"
 
 [lints.rust]
 future_incompatible = { level = "warn", priority = -1}

Cargo.toml

@@ -1,9 +1,14 @@
-`HighFlowNext` is a Rust library for communicating with the [Aquacomputer high flow NEXT](https://shop.aquacomputer.de/Monitoring-and-Controlling/Sensors/Flow-sensor-high-flow-NEXT-G1-4::3953.html) device. It provides strongly typed access to the device’s binary protocol, allowing you to interact with sensor values, settings, and configuration in a safe and structured way. The primary goal of this project is to enable clean integration of the high flow NEXT into [OpenRGB](https://openrgb.org/), so that device data and lighting controls can be accessed and managed alongside other RGB hardware.
+<p>
+    <img src="doc/logo.png" alt="logo" width="128" style="float: left; margin: 0 10px 10px 0;" />
+    <code>HighFlowNext</code> is a Rust library for communicating with the <a href="https://shop.aquacomputer.de/Monitoring-and-Controlling/Sensors/Flow-sensor-high-flow-NEXT-G1-4::3953.html">Aquacomputer high flow NEXT</a> device. It provides strongly typed access to the device’s binary protocol, allowing you to interact with sensor values, settings, and configuration in a safe and structured way. The primary goal of this project is to enable clean integration of the high flow NEXT into <a href="https://openrgb.org">OpenRGB</a>, so that device data and lighting controls can be accessed and managed alongside other RGB hardware.
+</p>
 
 > [!IMPORTANT]
+>
 > This is **not an official implementation** from Aquacomputer.
 
 > [!WARNING]
+>
 > No guarantees are given regarding correctness, completeness, or stability of the protocol description. Use it at your own risk.
 
 # Features
@@ -26,7 +31,7 @@ Beyond `OpenRGB`, the crate can also support monitoring, logging, and automation
 # Protocol Specification
 
 If you are only interested in the details of the communication protocol itself,
-please have a look at the included [specification file](https://github.com/Bergmann89/HighFlowNext/blob/master/protocol/SPECIFICATION). It describes the binary
+please have a look at the included [specification file](https://github.com/Bergmann89/HighFlowNext/blob/master/doc/SPECIFICATION). It describes the binary
 layout of settings, frames, effects, colors, and source control mappings.
 
 # License

README.md

@@ -0,0 +1,39 @@
+//! Build script for the `xsd_parser` crate.
+
+use std::env::var;
+use std::fs::{read, read_to_string, write};
+use std::path::PathBuf;
+
+use base64::{prelude::BASE64_STANDARD, Engine};
+use regex::{Captures, Regex};
+
+fn main() {
+    let cargo_dir =
+        var("CARGO_MANIFEST_DIR").expect("Missing `CARGO_MANIFEST_DIR` environment variable!");
+    let cargo_dir = PathBuf::from(cargo_dir);
+
+    let readme = cargo_dir.join("README.md");
+    let logo_png = cargo_dir.join("doc/logo.png");
+
+    println!("cargo:rerun-if-changed={}", readme.display());
+    println!("cargo:rerun-if-changed={}", logo_png.display());
+
+    let rx = Regex::new(r"\[!([A-Z]+)\]").unwrap();
+
+    let logo_png = read(logo_png).expect("Unable to load `doc/logo.png`");
+    let logo_png = BASE64_STANDARD.encode(logo_png);
+    let logo_png = format!("data:image/png;base64,{logo_png}");
+
+    let readme = read_to_string(readme).expect("Unable to read `README.md`");
+    let readme = readme.replace("doc/logo.png", &logo_png);
+    let readme = rx.replace_all(&readme, |c: &Captures<'_>| {
+        let keyword = &c[1];
+
+        format!("**{keyword}**")
+    });
+
+    let out_dir = var("OUT_DIR").expect("Missing `OUT_DIR` environment variable!");
+    let out_dir = PathBuf::from(out_dir);
+
+    write(out_dir.join("README.md"), &*readme).expect("Unable to write `README.md`");
+}

build.rs

@@ -1,4 +1,4 @@
-#![doc = include_str!("../README.md")]
+#![doc = include_str!(concat!(env!("OUT_DIR"), "/README.md"))]
 
 pub mod misc;
 pub mod protocol;