From 2e18fc63712609e7e6045b9d28794acfca6486b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Magalh=C3=A3es?= <joamag@gmail.com> Date: Sun, 30 Apr 2023 16:01:01 +0100 Subject: [PATCH] feat: new docs --- frontends/sdl/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/frontends/sdl/README.md b/frontends/sdl/README.md index e9584850..54993285 100644 --- a/frontends/sdl/README.md +++ b/frontends/sdl/README.md @@ -2,6 +2,8 @@ ## Build +### Build SDL using [vcpkg](https://vcpkg.io/) + To be able to run the `cargo build` one must first install a local version of `vcpkg` using: ```bash @@ -10,6 +12,25 @@ cargo vcpkg build cargo build ``` +#### Build SDL in Windows + +For windows the vcpk based SDL building is simpler: + +```bash +cargo install cargo-vcpkg +cargo build +``` + +Make sure that the current Rust in use is msvc based using: + +```bash +rustup default stable-msvc +``` + +For more information check [GitHub - Rust-SDL2/rust-sdl2](https://github.com/Rust-SDL2/rust-sdl2). + +## Build binaries + Then you can use the following command to build and run Boytacean SDL: ```bash @@ -30,6 +51,8 @@ There are some feature flags that control the verbosity of the emulator to run i cargo run --features debug ``` +To obtain more information about the issues. + ## Features | Provider | Description | -- GitLab