lemur/README.md

Lemur

A Virtual Boy emulator built around the shrooms-vb core. Written in Rust, using winit, wgpu, and egui. Should run on any major OS.

Install

You can find the latest version, along with setup instructions, in the Releases section.

Compile

Install the following dependencies:

• cargo (via rustup, the version from your package manager is too old)
• a C compiler (any will do, the build script will find it automatically)
• (on linux) libasound2-dev and libudev-dev

Run

cargo build --release

The executable will be in target/release/lemur[.exe].

Bundle

Run this script:

./scripts/bundle.sh

It uses Docker to cross compile for Windows, MacOS, and Linux. All binaries are left in the output directory.

Release

Bump the version number in Cargo.toml, then run this script:

./scripts/release.sh

It will check for gitea credentials before doing anything.