diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..7b638ed --- /dev/null +++ b/INSTALL.md @@ -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. diff --git a/README.md b/README.md index 5a3008e..588dfe4 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,9 @@ # mqrs `mqrs` is a small cli application to handle POSIX message queues. -## Installation -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 -``` - -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. +## Install `mqrs` +For information about how to build, install and run `mqrs` please see +[`INSTALL.md`](INSTALL.md). ## Using `mqrs` Depending on which backend you want to use there are different subsets