From 003db65f9cbe8bab9f3bc22d6e83d130e5752d2e Mon Sep 17 00:00:00 2001 From: yyc12345 Date: Sat, 1 Aug 2026 18:59:51 +0800 Subject: [PATCH] chore: update metadata and doc - update cargo metadata for future submit - update document --- README.md | 4 ++-- omrf/Cargo.lock | 2 +- omrf/Cargo.toml | 9 ++++++++- omrf/README.md | 18 ++++++++++++++++++ 4 files changed, 29 insertions(+), 4 deletions(-) create mode 100644 omrf/README.md diff --git a/README.md b/README.md index eefa7af..22a10bc 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ Sarasas Chip Workshop Oh My Rust FFI (abbr. SarasaCW OMRF) is a toolset includin - A Rust crate providing various facilities for C-friendly FFI. - A Python written tool for creating distribution and generating CMake and pkg-config files. -- A document instructs how to write header files manually (actually performed as AI prompt and let AI do it). -- A document instructs how to map Rust specific struct like `Option`, `Result` and etc to C-friendly FFI interface. +- A document instructs how to design C-friendly FFI signatures and write C/C++ header files, +involving how to pass primitive type, enum type, string and Rust specific structs like `Option`, `Result`. ## Why not XXX? diff --git a/omrf/Cargo.lock b/omrf/Cargo.lock index 4ebf116..3dcb8c1 100644 --- a/omrf/Cargo.lock +++ b/omrf/Cargo.lock @@ -103,7 +103,7 @@ dependencies = [ [[package]] name = "sarasacw-omrf" -version = "0.1.0" +version = "1.0.0" dependencies = [ "dashmap", "thiserror", diff --git a/omrf/Cargo.toml b/omrf/Cargo.toml index 1266708..76659a4 100644 --- a/omrf/Cargo.toml +++ b/omrf/Cargo.toml @@ -1,7 +1,14 @@ [package] name = "sarasacw-omrf" -version = "0.1.0" +version = "1.0.0" edition = "2024" +rust-version = "1.85" +description = "The facilities for Rust, specifically designed for the SarasaCW OMRF project, to support C-friendly FFI." +license = "MIT" +repository = "https://github.com/SarasasChipWorkshop/sarasacw-omrf" +readme = "README.md" +keywords = ["ffi", "c", "interop"] +categories = ["api-bindings", "development-tools::ffi"] [dependencies] thiserror = "2.0.12" diff --git a/omrf/README.md b/omrf/README.md new file mode 100644 index 0000000..f8c07d9 --- /dev/null +++ b/omrf/README.md @@ -0,0 +1,18 @@ +# sarasacw-omrf + +The Rust crate component of **Oh My Rust FFI (SarasaCW OMRF)** — a toolset from Sarasas Chip +Workshop for authoring Rust libraries that can be distributed and consumed like ordinary CMake +C/C++ libraries. + +This crate provides a small set of facilities for code that is meant to be called from C/C++ +(or any FFI), designed around a distribution-friendly, CMake / pkg-config-style workflow rather +than in-tree build integration. + +## Status + +Barely works for the specific workflow of Sarasas Chip Workshop. +And will be improved by new requirement coming from Sarasas Chip Workshop devlopment. + +## License + +Licensed under the MIT License.