lemur/README.md

27 lines
805 B
Markdown
Raw Permalink Normal View History

2024-12-08 19:49:54 +00:00
# Lemur
2024-10-15 05:06:52 +00:00
2024-12-08 19:49:54 +00:00
A Virtual Boy emulator built around the shrooms-vb core. Written in Rust, using winit, wgpu, and egui. Should run on any major OS.
2024-10-15 05:06:52 +00:00
## Setup
Install the following dependencies:
- `cargo` (via [rustup](https://rustup.rs/), the version from your package manager is too old)
2025-03-04 14:46:26 +00:00
- a C compiler (any will do, [the build script](https://docs.rs/cc/latest/cc/#compile-time-requirements) will find it automatically)
- (on linux) `libasound2-dev` and `libudev-dev`
2024-10-15 05:06:52 +00:00
Run
```sh
2024-11-07 04:55:25 +00:00
cargo build --release
```
2024-12-16 05:38:16 +00:00
The executable will be in `target/release/lemur[.exe]`
## Release
Bump the version number in `Cargo.toml`, then run this script:
```sh
./scripts/release.sh
```
It uses docker to cross compile for Windows, MacOS, and Linux. All binaries are left in the `output` directory.