Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Building from source

Prerequisites

Snow is written in the Rust programming language. To install the official Rust toolchain, simply follow the steps on rustup.rs.

Snow uses a rust-toolchain.toml file to specify the version of the Rust toolchain it requires. Cargo will download and install this version automatically (if needed) when you build.

Building Snow depends on having SDL2 available on your system as well as pkg-config to find the library.

On Mac, if you have brew installed, you can install the dependencies using:

brew install pkg-config sdl2

On Linux, the name of your packages depends on your distribution, but they should be generally available. On Debian or Ubuntu, you can run:

sudo apt install libsdl2-dev pkg-config

Building and running from source

To build and run the GUI after checking out the source, simply run:

cargo run -r
Make sure you always pass the `-r` or `--release` flag to create a release build. The debug build is unoptimized and will therefore be very slow.

Running tests

If you plan on developing Snow, you may want to run the unit test suite. As a prerequisite, you need the m68000 single step test submodule checked out. To do this, run:

git submodule update --init --recursive

Then, you need to generate the JSON files for the single step tests. You only have to do this once. Run:

cd testdata/m68000
python decode.py

After this, you can run the unit tests from the root directory of the Snow repository using:

cargo test