Move install section into its own file
To keep the readme manageable and clear move help about how to build, install and run into its own file.
This commit is contained in:
parent
07decf7b36
commit
a468c5d7bb
2 changed files with 52 additions and 49 deletions
49
INSTALL.md
Normal file
49
INSTALL.md
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
# Installation
|
||||||
|
To build `mqrs` having the rust toolchain installed is mandatory.
|
||||||
|
|
||||||
|
## Install Rust
|
||||||
|
Install the Rust toolchain from [rustup.rs](https://rustup.rs).
|
||||||
|
|
||||||
|
## Build `mqrs`
|
||||||
|
`mqrs` can be built for development:
|
||||||
|
```sh
|
||||||
|
cargo b
|
||||||
|
```
|
||||||
|
|
||||||
|
or for releasing:
|
||||||
|
```sh
|
||||||
|
cargo b --release
|
||||||
|
```
|
||||||
|
|
||||||
|
## Build the `mqrs` Debian package
|
||||||
|
For that [`cargo-deb`](https://github.com/mmstick/cargo-deb) is
|
||||||
|
required, which can be installed with:
|
||||||
|
```sh
|
||||||
|
cargo install cargo-deb
|
||||||
|
```
|
||||||
|
|
||||||
|
A Debian package can be built with:
|
||||||
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
|
or from within the project:
|
||||||
|
```sh
|
||||||
|
cargo install mqrs
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run `mqrs`
|
||||||
|
`mqrs` can either be run from the project directory with:
|
||||||
|
```sh
|
||||||
|
cargo b
|
||||||
|
```
|
||||||
|
|
||||||
|
or you can copy the produced binary somewhere else or link to them
|
||||||
|
from `target/{debug,release}/mqrs` depending on which one you built.
|
52
README.md
52
README.md
|
@ -1,55 +1,9 @@
|
||||||
# mqrs
|
# mqrs
|
||||||
`mqrs` is a small cli application to handle POSIX message queues.
|
`mqrs` is a small cli application to handle POSIX message queues.
|
||||||
|
|
||||||
## Installation
|
## Install `mqrs`
|
||||||
To build `mqrs` a rust toolchain is necessary.
|
For information about how to build, install and run `mqrs` please see
|
||||||
|
[`INSTALL.md`](INSTALL.md).
|
||||||
### Install Rust
|
|
||||||
Install the Rust toolchain from [rustup.rs](https://rustup.rs).
|
|
||||||
|
|
||||||
### Build `mqrs`
|
|
||||||
`mqrs` can be built for development:
|
|
||||||
```sh
|
|
||||||
cargo b
|
|
||||||
```
|
|
||||||
|
|
||||||
or for releasing:
|
|
||||||
```sh
|
|
||||||
cargo b --release
|
|
||||||
```
|
|
||||||
|
|
||||||
### Build the `mqrs` Debian package
|
|
||||||
For that [`cargo-deb`](https://github.com/mmstick/cargo-deb) is
|
|
||||||
required, which can be installed with:
|
|
||||||
```sh
|
|
||||||
cargo install cargo-deb
|
|
||||||
```
|
|
||||||
|
|
||||||
A Debian package can be built with:
|
|
||||||
```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
|
|
||||||
```
|
|
||||||
|
|
||||||
or from within the project:
|
|
||||||
```sh
|
|
||||||
cargo install mqrs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run `mqrs`
|
|
||||||
`mqrs` can either be run from the project directory with:
|
|
||||||
```sh
|
|
||||||
cargo b
|
|
||||||
```
|
|
||||||
|
|
||||||
or you can copy the produced binary somewhere else or link to them
|
|
||||||
from `target/{debug,release}/mqrs` depending on which one you built.
|
|
||||||
|
|
||||||
## Using `mqrs`
|
## Using `mqrs`
|
||||||
Depending on which backend you want to use there are different subsets
|
Depending on which backend you want to use there are different subsets
|
||||||
|
|
Loading…
Reference in a new issue