Skip to content

BUILD.md: add WSL build instructions #2688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DevreeseJorik wants to merge 1 commit into
base: master
Choose a base branch
from
Open

BUILD.md: add WSL build instructions #2688

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,27 @@
cmake -B build
cmake --build build -j$(nproc --all)
```
4. melonDS should now be in the `build` folder.
Run it as follows:
```bash
./build/melonDS
```

## Windows

### Option A: WSL (Windows Subsystem for Linux)

Windows Subsystem for Linux (WSL) allows you to run a Linux environment directly on Windows. It is recommended to use WSL2, which has better performance and compatibility than WSL1.

With WSL, you can build melonDS using the same instructions as for Linux, and run it directly from WSL with GUI support (WSLg) on Windows 11.

1. Install WSL and a Linux distribution (Ubuntu is recommended) from the Microsoft Store.
2. Follow the [Linux](#linux) instructions for your chosen distribution.
Note that for WSL Ubuntu 22.04, you need to install the following packages instead of the ones listed in the Linux section:
* 22.04: `sudo apt install qt6-base-dev qt6-base-private-dev qt6-multimedia-dev libqt6svg6-dev`

### Option B: MSYS2 (native Windows build)

1. Install [MSYS2](https://www.msys2.org/)
2. Open the MSYS2 terminal from the Start menu:
* For x64 systems (most common), use **MSYS2 UCRT64**
Expand Down