Support cargo-deb and fix readme

This commit is contained in:
finga 2021-06-20 17:39:22 +02:00
parent c33294f00b
commit 487d5a9971
2 changed files with 22 additions and 11 deletions

View file

@ -12,3 +12,10 @@ anyhow = "1.0"
clap = "3.0.0-beta.2" clap = "3.0.0-beta.2"
posixmq = "1.0" posixmq = "1.0"
chrono = "0.4" 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"],
]

View file

@ -2,39 +2,43 @@
`mqrs` is a small cli application to handle POSIX message queues. `mqrs` is a small cli application to handle POSIX message queues.
## Installation ## Installation
Currently `mqrs` can only be built with the rust toolchain. Support To build `mqrs` a rust toolchain is necessary.
for `cargo-deb` is imminent.
### Install Rust ### Install Rust
Install the Rust toolchain from [rustup.rs](https://rustup.rs). Install the Rust toolchain from [rustup.rs](https://rustup.rs).
### Build `mqrs` ### Build `mqrs`
`mqrs` can be built for development: `mqrs` can be built for development:
``` sh ```sh
cargo b cargo b
``` ```
or for releasing: or for releasing:
``` sh ```sh
cargo b --release cargo b --release
```
### Build the `mqrs` Debian package
```sh
cargo deb
``` ```
### Install `mqrs` ### Install `mqrs`
When a Rust toolchain installed you can also install `mqrs` When a Rust toolchain installed you can also install `mqrs`
directly without cloning it manually: directly without cloning it manually:
``` sh ``` 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: or from within the project:
``` sh ```sh
cargo install mqrs cargo install mqrs
``` ```
### Run `mqrs` ### Run `mqrs`
`mqrs` can either be run from the project directory with: `mqrs` can either be run from the project directory with:
``` sh ```sh
cargo b cargo b
``` ```
or you can copy the produced binary somewhere else or link to them or you can copy the produced binary somewhere else or link to them