test

Author: ckrenslehner

.github/workflows/rust.yml

@@ -11,8 +11,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
+      - uses: extractions/setup-just@v2
+      - uses: hustcer/setup-nu@v3
       - run: cargo install cargo-readme
       - run: cargo-readme --help
+      - run: just -l
 
 # jobs:
 #   spelling:

justfile

@@ -1,4 +1,4 @@
-# Nushell needs to be installeds
+# Nushell needs to be installed
 set shell := ["nu", "-c"]
 
 shebang := if os() == 'windows' {
@@ -24,6 +24,12 @@ sample-env-file:
 
     echo $content | save .env
 
+# Run cargo-readme to update the readme files
+update-readme:
+    cd stm32cubeprogrammer ; cargo readme | save README.md -f
+    cd stm32cubeprogrammer-cli ; cargo readme | save README.md -f
+    cd stm32cubeprogrammer-sys ; cargo readme | save README.md -f
+
 # Run all tests or a specific test with a specific verbosity
 # The log level maps to the `log` crate log levels: trace, debug, info, warn, error
 test name="" log_level="trace":

stm32cubeprogrammer-sys/README.md

@@ -0,0 +1,6 @@
+# stm32cubeprogrammer-sys
+
+This crate provides low level bindings to the STM32CubeProgrammer API.
+The bindings are generated using bindgen and use the [`libloading`](https://crates.io/crates/libloading) crate to support dynamic loading of the CubeProgrammer API.
+
+License: MIT

stm32cubeprogrammer-sys/src/lib.rs

@@ -1,3 +1,5 @@
+//! This crate provides low level bindings to the STM32CubeProgrammer API.
+//! The bindings are generated using bindgen and use the [`libloading`](https://crates.io/crates/libloading) crate to support dynamic loading of the CubeProgrammer API.
 #![allow(
     non_snake_case,
     non_camel_case_types,