chore: update metadata and doc

- update cargo metadata for future submit
- update document
This commit is contained in:
2026-08-01 18:59:51 +08:00
parent 7834741d90
commit 003db65f9c
4 changed files with 29 additions and 4 deletions
+2 -2
View File
@@ -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 Rust crate providing various facilities for C-friendly FFI.
- A Python written tool for creating distribution and generating CMake and pkg-config files. - 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 design C-friendly FFI signatures and write C/C++ header files,
- A document instructs how to map Rust specific struct like `Option`, `Result` and etc to C-friendly FFI interface. involving how to pass primitive type, enum type, string and Rust specific structs like `Option`, `Result`.
## Why not XXX? ## Why not XXX?
+1 -1
View File
@@ -103,7 +103,7 @@ dependencies = [
[[package]] [[package]]
name = "sarasacw-omrf" name = "sarasacw-omrf"
version = "0.1.0" version = "1.0.0"
dependencies = [ dependencies = [
"dashmap", "dashmap",
"thiserror", "thiserror",
+8 -1
View File
@@ -1,7 +1,14 @@
[package] [package]
name = "sarasacw-omrf" name = "sarasacw-omrf"
version = "0.1.0" version = "1.0.0"
edition = "2024" 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] [dependencies]
thiserror = "2.0.12" thiserror = "2.0.12"
+18
View File
@@ -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.