The first requirement for building a Renoir project is the Rust toolchain.

Installing Rust

  • Using Rustup (Recommended): follow the instructions at https://rustup.rs/
    • Linux (Recommended):

      ~$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    • Windows: Download and run the installer

  • Using your package manager: in alternative you can use the package provided by your repository

Add rust toolchain to PATH

In order to use all the tools of the Rust toolchain we need to add the โ€~/.cargo/bin/โ€ folder in our PATH

  • bash:
~$ echo 'export PATH=$PATH:~/.cargo/bin/' >> ~/.bashrc
  • fish:
~$ set -xU fish_user_paths $fish_user_paths ~/.cargo/bin/

Create a new cargo project

After we succesfully installed the Rust toolchain we are ready to create wonders with Renoir. To do that we are going to create a new project adding Renoir to its dependencies.

cargo new --bin renoir-test
cd renoir-test
 # Add the renoir dependency to the `Cargo.toml`
 # Currently we recommend using the GitHub repository directly
cargo add renoir --git https://github.com/deib-polimi/renoir

You can now open the project in your editor of choice and start writing your application using Renoir!

Bonus Tip: Development Environment