Installation

There are two modes of Installation. Since the project is not fully stable yet, it is advised to install from source. Make sure you have the Rust Programming language installed. Refer to the official website

1. Installation from crates.io

Xiron can be downloaded from crates.io using

cargo install xiron

In a new terminal, run the simulator using

xiron_simulator

2. Source Installation

a. Dependencies Installation

Install the Rust Programming language from their official website
On Linux, you need to first run:

sudo apt-get install -y libclang-dev libgtk-3-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev

On Fedora Rawhide, you need to run

dnf install clang clang-devel clang-tools-extra libxkbcommon-devel pkg-config openssl-devel libxcb-devel gtk3-devel atk fontconfig-devel

There are no dependencies apart from Rust for Windows and Mac.

To install from source, you will need to install the Rust Programming language.

b. Source Code

Clone the source code from Github

git clone https://github.com/SuhrudhSarathy/xiron.git

c. Build Library and Simulator

To build the library and simulator run:

cargo build

By default, this will build the library and simulator in debug mode. To build in release mode,

cargo build --release

The built simulator can be found as a binary in the target/debug or target/release folder depending on whether the build was in debug mode or release mode.
You can also run the simulator using cargo with

cargo run --bin xiron_simulator

This runs the simulator in debug mode. To run in release mode,

cargo run --bin xiron_simulator --release