Skip to content

How to Use

Jump to bottom
Mateo Rodriguez edited this page Feb 6, 2024 · 2 revisions

Installation guide and tips

Download it

To use MScript, download one of the precompiled binaries from the Releases tab. It is in your best interest to use the latest version available, as falling out of date with the release train can lead to a buggy runtime and incompatibilities.

Build it yourself

Alternatively, you can build MScript on your own box. MScript is developed on the latest version of Rust (it is good practice to periodically run rustup update anyways), and reports related to compilation errors on lower versions will not be considered.

Running cargo build --release in the root of the project will build:

  • The interpreter/runtime
  • The compiler
  • The CLI frontend
  • Developer tools

The production binary will be outputted in the standard /target/release folder. Tip: adding it to path will make your life easier! Compiling on Linux works out of the box. Tests on Ubuntu 18.04, Debian 12, WSL and Raspberry Pi OS works out of the box.

Note for Windows Developers 🚨 Some dependencies rely on the MSVC toolchain on Windows. This means that you must have installed BOTH the Windows SDK AND Microsoft Visual Studio Build Tools before compiling, otherwise you will get a metric buttload of cryptic linker errors.

Don't forget to download the `msvc` toolchain for your system! Eg.

rustup target add x86_64-pc-windows-msvc

If the msvc toolchain is not your default, you must specify the target triple via the --target flag on cargo build

Clone this wiki locally