Dependencies

Linux

In order to use rin you'll need to install rust first. Usually it can be installed with:

curl https://sh.rustup.rs -sSf | sh

But you can check their install page for more options.

Rin depends on some c libraries, we plan to remove them at some point but right now you'll need to install cmake and the basic c / c++ development tools so Rust can compile them.

In debian/ubuntu derived distributions you can install them with:

sudo apt install build-essential cmake

In archlinux:

pacman -Sy base-devel cmake

In fedora:

sudo dnf install gcc gcc-c++ autoconf automake cmake

Windows

In order to use rin you'll need to install rust first. Just follow the instructions in their webpage to get it ready.

Rin depends on some c libraries, we plan to remove them at some point but right now you'll need to install cmake and visual studio so Rust can compile them.

You usually will install cmake for windows from their msi installer:

-64 bits: https://cmake.org/files/v3.11/cmake-3.11.2-win64-x64.msi -32 bits: https://cmake.org/files/v3.11/cmake-3.11.2-win32-x86.msi

When installing cmake be sure to select one of the Add CMake to the system PATH options.

cmake path

Then restart the console and if you had an IDE already installed and open restart it as well.

For visual studio you usually want to install the option Visual Studio IDE > Community 2017

Macos

In order to use rin you'll need to install rust first. Usually it can be installed with:

curl https://sh.rustup.rs -sSf | sh

But you can check their install page for more options.

Rin depends on some c libraries, we plan to remove them at some point but right now you'll need to install cmake and xcode or at least the xcode console tools so Rust can compile them.

Installation

You can now install rin's project generator running:

cargo install rinpg

To update to a new version later you can run:

cargo install --force rinpg

You can now create new rin projects by running from a console:

cargo rin new project_path

Which will create a default empty project.

From there on you can use plain cargo to build and run your application but cargo rin also gives you more options specific to rin projects. Run cargo rin --help for more options.

IDE install

Rust provides autocomplete and static analisys through the Rust Language Server

Although rls works on rust stable it seems to have some problems at the moment. Because of this we recomend using rust nightly by now:

rustup install nightly
rustup default nightly

Then install rls:

rustup update
rustup component add rls-preview rust-analysis rust-src

Now you can install any IDE with support for rls (usually through extensions). Rin has been mostly tested with visual code and atom.

For visual code we recomend to install the Rust (rls) and Better TOML extensions.

For atom the ide-rust package along with the language-rust package.

Other IDEs with Rust support should work as well or even just using any text editor and compiling from the command line using cargo build and cargo run.