diff --git a/Cargo.toml b/Cargo.toml index 8bbbe5c..a3a6393 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,3 +12,10 @@ anyhow = "1.0" clap = "3.0.0-beta.2" posixmq = "1.0" chrono = "0.4" + +[package.metadata.deb] +extended-description = "`mqrs` is a small cli application to handle POSIX message queues." +assets = [ + ["target/release/mqrs", "usr/bin/", "755"], + ["README.md", "usr/share/doc/cargo-deb/README.md", "644"], +] diff --git a/README.md b/README.md index c546b65..2ff0d81 100644 --- a/README.md +++ b/README.md @@ -2,39 +2,43 @@ `mqrs` is a small cli application to handle POSIX message queues. ## Installation -Currently `mqrs` can only be built with the rust toolchain. Support -for `cargo-deb` is imminent. +To build `mqrs` a rust toolchain is necessary. ### Install Rust Install the Rust toolchain from [rustup.rs](https://rustup.rs). ### Build `mqrs` `mqrs` can be built for development: -``` sh - cargo b +```sh +cargo b ``` or for releasing: -``` sh - cargo b --release +```sh +cargo b --release +``` + +### Build the `mqrs` Debian package +```sh +cargo deb ``` ### Install `mqrs` When a Rust toolchain installed you can also install `mqrs` directly without cloning it manually: ``` sh - cargo install --git https://git.onders.org/finga/mqrs.git mqrs +cargo install --git https://git.onders.org/finga/mqrs.git mqrs ``` or from within the project: -``` sh - cargo install mqrs +```sh +cargo install mqrs ``` ### Run `mqrs` `mqrs` can either be run from the project directory with: -``` sh - cargo b +```sh +cargo b ``` or you can copy the produced binary somewhere else or link to them