PVB/lemur
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 53 Wiki Activity

Update README

Browse Source
This commit is contained in:
SonicSwordcane
2026-11-03 20:33:21 -05:00
parent 72c7a6b6d6
commit c310fb0864
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -3
View File
@@ -2,7 +2,11 @@
A Virtual Boy emulator built around the shrooms-vb core. Written in Rust, using winit, wgpu, and egui. Should run on any major OS. A Virtual Boy emulator built around the shrooms-vb core. Written in Rust, using winit, wgpu, and egui. Should run on any major OS.
## Setup ## Install
You can find the latest version, along with setup instructions, in [the Releases section](https://git.virtual-boy.com/PVB/lemur/releases).
## Compile
Install the following dependencies: Install the following dependencies:
- `cargo` (via [rustup](https://rustup.rs/), the version from your package manager is too old) - `cargo` (via [rustup](https://rustup.rs/), the version from your package manager is too old)
@@ -14,7 +18,17 @@ Run
cargo build --release cargo build --release
``` ```
The executable will be in `target/release/lemur[.exe]` The executable will be in `target/release/lemur[.exe]`.
## Bundle
Run this script:
```sh
./scripts/bundle.sh
```
It uses Docker to cross compile for Windows, MacOS, and Linux. All binaries are left in the `output` directory.
## Release ## Release
@@ -24,4 +38,4 @@ Bump the version number in `Cargo.toml`, then run this script:
./scripts/release.sh ./scripts/release.sh
``` ```
It uses docker to cross compile for Windows, MacOS, and Linux. All binaries are left in the `output` directory. It will check for gitea credentials before doing anything.