finga/mqrs

finga a468c5d7bb 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.

2021-07-07 19:40:14 +02:00

Installation

To build mqrs having the rust toolchain installed is mandatory.

Install Rust

Install the Rust toolchain from rustup.rs.

mqrs can be built for development:

cargo b

or for releasing:

cargo b --release

For that cargo-deb is required, which can be installed with:

cargo install cargo-deb

A Debian package can be built with:

cargo deb

When a Rust toolchain installed you can also install mqrs directly without cloning it manually:

cargo install --git https://git.onders.org/finga/mqrs.git mqrs

or from within the project:

cargo install mqrs

mqrs can either be run from the project directory with:

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.