diff --git a/rust/Cargo.toml.in b/rust/Cargo.toml.in index b61e3ec7f..d217a530e 100644 --- a/rust/Cargo.toml.in +++ b/rust/Cargo.toml.in @@ -17,7 +17,10 @@ [package] name = "guestfs" -version = "@VERSION@" +version = "0.1.0-compat@VERSION@" edition = "2018" +authors = ["Hiroyuki Katsura "] +description = "libguestfs bindings for Rust" +license-file = "../COPYING" [dependencies] diff --git a/rust/README.md b/rust/README.md new file mode 100644 index 000000000..f7dd96d39 --- /dev/null +++ b/rust/README.md @@ -0,0 +1,42 @@ +# libguestfs bindings for Rust + +This package contains the libguestfs bindings for Rust. You can use this crate +by using cargo. See [crates.io](https://https://crates.io/crates/guestfs) + +# For maintainer + +## How to test + +Tests are incorporated into the build system. + +You can test it manually by + +``` +$ ../run cargo test +``` + +## How to publish + +### 1. Fix version in Cargo.toml.in + +Regarding Versioning convention, see [Semantic +Versioning](https://semver.org/). + +You must not break '-compat@VERSION@' to make sure that this binding is +compatible with the installed libguestfs. + +Example +``` +version = "0.1.0-compat@VERSION@" +``` + +### 2. Commit the change of the version + +### 3. Build libguestfs + +### 4. Publish + +``` +$ cargo publish +``` +