Skip to content

Commit

Permalink
Rewrite README a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
Harrm committed Jul 23, 2024
1 parent 993e7ea commit 0197cad
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,9 @@ This repo contains wrappers for rust library which KAGOME uses.
The crates in crates/ dir declare C API wrappers for Rust libraries and use cbindgen to generate an actual C header.
They need to be in the same CMake project so that Hunter, KAGOME's package manager, always builds them all with the same Rust compiler, otherwise conflicts in Rust runtime symbols happen when linking.
In case any of those are required in projects other than KAGOME, this repo may be repurposed in one of the following ways:
- Extract cmake/add_rust_library.cmake, cmakeConfig.cmake.in and cbingden.toml, along with crates/build-helper crate to a separate repo and use it as a dependency here and for the new project.
- Extract the following to a separate repo and use it as a dependency here and for the new project:
- cmake/add_rust_library.cmake
- cmakeConfig.cmake.in
- cbingden.toml
- crates/build-helper crate
- Rewrite CMakeLists.txt here so that the list of the rust crates is not hardcoded, but passed as an argument to CMake, so that projects that depend on the current one may just pass the desired list of Rust-to-C binding repos.

0 comments on commit 0197cad

Please sign in to comment.