From 15c8b684cfbe87496d7db0dc0603a7a8a812af66 Mon Sep 17 00:00:00 2001 From: Dargor Date: Mon, 7 Sep 2026 18:11:24 -0300 Subject: [PATCH 1/2] add build instructions for wsl --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 5c52b742..53ba4b05 100644 --- a/README.md +++ b/README.md @@ -170,12 +170,28 @@ Any help is greatly appreciated! Below are some basic steps to get started and b git clone --recursive https://github.com/roengstrom/ff8-decomp.git cd ff8-decomp ``` + - **Note:** If you are using Windows, you must use **WSL 2** to build the project. + + The following distributions have been tested for building the project: + + | Distro | Can build? | + |:------------:|:----------:| + | Ubuntu-22.04 | ✅ | + | Ubuntu-24.04 | ✅ | + | Ubuntu-26.04 | ❌ | + + On a fresh installation, run the following commands to install the packages required to build the project: + ```bash + sudo apt update + sudo apt install python3-venv make build-essential binutils-mipsel-linux-gnu + ``` 2. **Create a Python venv and install splat**: ```bash python3 -m venv .venv .venv/bin/pip install -e "tools/splat[mips]" ``` + - **Note:** If you are using WSL and encounter an error, try run the command with `sudo`. 3. **Provide your own disc image** — You need a BIN/CUE of FF8 Disc 1 (USA, SLUS-00892). From a3c9042bfd1e7bd3270249910b5ab45548a51223 Mon Sep 17 00:00:00 2001 From: dargor123 Date: Tue, 8 Sep 2026 16:49:14 -0300 Subject: [PATCH 2/2] remove sudo mention from build instructions --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 53ba4b05..75f589c6 100644 --- a/README.md +++ b/README.md @@ -191,7 +191,6 @@ Any help is greatly appreciated! Below are some basic steps to get started and b python3 -m venv .venv .venv/bin/pip install -e "tools/splat[mips]" ``` - - **Note:** If you are using WSL and encounter an error, try run the command with `sudo`. 3. **Provide your own disc image** — You need a BIN/CUE of FF8 Disc 1 (USA, SLUS-00892).