From fc3b6435e18a491d580fc7f36ea3f0efe3b9cf49 Mon Sep 17 00:00:00 2001 From: Jika Date: Sun, 2 Nov 2025 12:27:48 +0100 Subject: [PATCH] Small Readme changes --- README.md | 8 ++++---- crates/oc2r-core/Readme.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1a3302f..fc85662 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ 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: +This repository is a workspace and is divided into multiple crates: -- `crates/oc2r-core`: mirrors the stock Lua helpers (`devices.lua`, `robot.lua`) so you can list devices, invoke methods, +- `crates/oc2r-core`: mirrors the stock Lua helpers (`devices.lua`) so you can list devices, invoke methods, subscribe to events, and work with the low-level RPC primitives. -- `crates/opencomputers`: companion crate that provides strongly typed wrappers for the common HLAPI peripherals. +- `crates/opencomputers`: provides strongly typed wrappers for the opencomputers HLAPI peripherals. - `crates/minapk`: minimal Alpine-style package installer tailored for OC2R Minux. ## Development @@ -20,7 +20,7 @@ There are more size optimisation done you can check the `.cargo/config.toml`, `C # Compilation -Simply `cross clippy --all-targets` to compile everything +Simply do `cross clippy --all-targets` to compile everything ## Examples diff --git a/crates/oc2r-core/Readme.md b/crates/oc2r-core/Readme.md index e757866..cd56051 100644 --- a/crates/oc2r-core/Readme.md +++ b/crates/oc2r-core/Readme.md @@ -2,7 +2,7 @@ Minimal Rust client for the OC2R high-level API. It mirrors the bundled Lua helper (`devices.lua`) so you can list devices, invoke methods, -and subscribe to events. For ergonomic wrappers on top of these primitives, add +and subscribe to events. For wrappers on top of these primitives, add the [`opencomputers`](../opencomputers) crate. ## Getting Started