Reworked a bit readme

Cargo.toml

@@ -3,7 +3,7 @@ resolver = "3"
 members = ["crates/*"]
 
 [workspace.package]
-authors = ["Christopher Head <chead@chead.ca>"]
+authors = ["Jika"]
 edition = "2024"
 repository = "https://git.jika.li/jika/oc2r-rust"
 license = "GPL-3.0-only"

README.md

@@ -1,39 +1,29 @@
-# OC2R Rust Client
+# OC2R Rust
 
-Thin, synchronous access to the OC2R high-level API from Rust. The crate mirrors
-the stock Lua helpers (`devices.lua`, `robot.lua`) so you can list devices, invoke methods,
+Thin, synchronous access to the [OpenComputers II: Reimagined](https://github.com/North-Western-Development/oc2r) high-level API for Rust.
+
+This repository is a workspace is divided into multiple crates:
+
+- `crates/oc2r-core`: mirrors the stock Lua helpers (`devices.lua`, `robot.lua`) so you can list devices, invoke methods,
 subscribe to events, and work with typed wrappers for common peripherals.
 
-## Documentation
-
-See [`docs/index.md`](docs/index.md) for the full guide and
-[`docs/wrappers.md`](docs/wrappers.md) for device-by-device examples.
-
 ## Development
 
-The crate targets rust nightly for some size optimisations and relies on `miniserde` and `libc`.
-
 To ease developpemnt we use [cross-rs](https://github.com/cross-rs/cross), 
 but you can install all toolchain component or your local computer and replace cross with cargo.
 
 By default the option "-Zfmt-debug=none" is set meaning all debug print (:?) are off. If you can disable this option at any time.
 
+There are more size optimisation done you can check the `.cargo/config.toml`, `Cargo.toml`, `Cross.toml` and [min-sized-rust](https://github.com/johnthagen/min-sized-rust) for more info.
+
 # Compilation
 
-Simply `cross clippy --all-targets` to compile all examples
+Simply `cross clippy --all-targets` to compile everything
 
 ## Examples
 
-Examples of how to use the crate are in the `examples` directory.
+Each crates has some examples of how to use it crate are in the `examples` directory.
 
-Build them with:
-
-```bash
-cross build --release --example example-names
-```
-
-Copy the resulting binaries from
-`target/<triple>/release/examples/` into Minux (an Import/Export card works
+Copy the resulting binaries from `target/<triple>/release/examples/` into Minux (an Import/Export card works
 well), mark them as executable and then execute them inside the VM.
 
-

crates/oc2r-core/Readme.md

@@ -0,0 +1,13 @@
+# OC2R-Core
+
+This crate mirrors the stock Lua helpers (`devices.lua`, `robot.lua`) so you can list devices, invoke methods,
+subscribe to events, and work with typed wrappers for common peripherals.
+
+## Documentation
+
+See [`docs/index.md`](docs/index.md) for the full guide and
+[`docs/wrappers.md`](docs/wrappers.md) for device-by-device examples.
+
+## Development
+
+The crate targets rust nightly for some size optimisations and relies on `miniserde` and `libc`.

crates/oc2r-core/docs/index.md

@@ -62,7 +62,7 @@ fn main() -> Result<()> {
 
 To avoid raw JSON, every base device has a wrapper with strongly typed methods:
 
-- `Redstone`
+- `RedstoneInterface`
 - `EnergyStorage`
 - `FluidHandler`
 - `ItemHandler`
@@ -71,8 +71,9 @@ To avoid raw JSON, every base device has a wrapper with strongly typed methods:
 - `BlockOperations`
 - `InventoryOperations`
 - `FileImportExport`
+- `Robot`
 
-Each wrapper exposes Rust-style methods (e.g. `Redstone::input`, `SoundCard::find`)
+Each wrapper exposes Rust-style methods (e.g. `RedstoneInterface::input`, `SoundCard::find`)
 built on top of the dynamic API. See [`wrappers.md`](wrappers.md) for detailed
 examples and method-by-method coverage.
 
@@ -81,9 +82,3 @@ examples and method-by-method coverage.
 - [Device wrapper reference](wrappers.md)
 - [Redstone event example](../examples/redstone-events.rs)
 - [Lua-style event loop](../src/event.rs)
-- [Performance comparison workflow](performance_testing.md)
-
-Contributions and further documentation improvements are welcome. Open an issue
-with suggestions or gaps you’d like filled.
-
-- [Redstone wrapper safety](redstone_considerations.md)

crates/oc2r-core/docs/wrappers.md

@@ -11,7 +11,7 @@ Before using any wrapper, attach it:
 
 ```rust
 let mut bus = DeviceBus::connect(DEFAULT_DEVICE_PATH)?;
-let mut redstone = oc2r_rust::Redstone::attach(&mut bus)?
+let mut redstone = oc2r_rust::RedstoneInterface::attach(&mut bus)?
     .expect("no redstone interface attached");
 // call unsubscribe() once you are done processing events
 redstone.subscribe()?;
@@ -40,7 +40,7 @@ robot.turn(RobotDirection::Left)?;
 ## Redstone
 
 ```rust
-use oc2r_rust::{Redstone, RedstoneSignal, Side};
+use oc2r_rust::{RedstoneInterface, RedstoneSignal, Side};
 
 redstone.set_output_state(Side::East, true)?;
 let input = redstone.input(Side::East)?;

crates/oc2r-core/src/devices/mod.rs

@@ -51,7 +51,7 @@ pub mod file_import_export;
 pub mod fluid_handler;
 pub mod inventory_operations;
 pub mod item_handler;
-pub mod redstone;
+pub mod redstone_interface;
 pub mod robot;
 pub mod sound;
 
@@ -62,6 +62,6 @@ pub use file_import_export::{FileImportExport, ImportedFileInfo};
 pub use fluid_handler::FluidHandler;
 pub use inventory_operations::InventoryOperations;
 pub use item_handler::ItemHandler;
-pub use redstone::{ParseSideError, Redstone, RedstoneSignal, Side};
+pub use redstone_interface::{ParseSideError, Redstone, RedstoneSignal, Side};
 pub use robot::{Robot, RobotDirection};
 pub use sound::SoundCard;

crates/oc2r-core/src/devices/redstone_interface.rs

@@ -4,12 +4,12 @@ use std::fmt;
 use std::str::FromStr;
 
 crate::devices::define_wrapper!(
-    Redstone,
+    RedstoneInterface,
     "redstone",
     "Typed wrapper around the HLAPI redstone interface."
 );
 
-impl<'bus> Redstone<'bus> {
+impl<'bus> RedstoneInterface<'bus> {
     /// Read the redstone input level for `side`.
     pub fn input(&mut self, side: Side) -> Result<f64> {
         self.device