feat: use mdBook for documentation (#10)

2025-08-28 23:22:04 +02:00
parent d98cd89c48
commit 3414589bd5
24 changed files with 317 additions and 194 deletions
@@ -0,0 +1,51 @@
+# sysinfo Tool
+
+The Rust based [sysinfo](https://github.com/zehnm/aoostar-rs/blob/main/crates/sysinfo) tool gathers many more system sensor values with the help of
+the [sysinfo](https://github.com/GuillaumeGomez/sysinfo) crate.
+
+It supports FreeBSD, Linux, macOS, Windows and other OSes, but it has only been tested on Linux so far.
+
+```
+Proof of concept sensor value collection for the asterctl screen control tool
+
+Usage: sysinfo [OPTIONS]
+
+Options:
+  -o, --out <OUT>
+          Output sensor file
+
+  -t, --temp-dir <TEMP_DIR>
+          Temporary directory for preparing the output sensor file.
+          
+          The system temp directory is used if not specified.
+          The temp directory must be on the same file system for atomic rename
+          operation!
+
+      --console
+          Print values in console
+
+  -r, --refresh <REFRESH>
+          System sensor refresh interval in seconds
+
+      --disk-refresh <DISK_REFRESH>
+          Enable individual disk refresh logic as used in AOOSTAR-X.
+          Refresh interval in seconds
+
+      --smartctl
+          Retrieve drive temperature if `disk-update` option is enabled.
+          
+          Requires smartctl and password-less sudo!
+```
+
+Single test run with printing all sensors in the console:
+```shell
+sysinfo --console
+```
+
+Normal mode providing sensor values for `asterctl` in `/tmp/sensors/sysinfo.txt` every 3 seconds:
+
+```shell
+sysinfo --refresh 3 --out /tmp/sensors/sysinfo.txt
+```
+
+Note: the lower the refresh rate, the more resources are used!