From 79c3c7d76fbf20c3ea4f12f110fb68b3e389e2cc Mon Sep 17 00:00:00 2001 From: Rachel Date: Sat, 27 Jul 2024 17:23:51 -0700 Subject: [PATCH] Update INSTALL.md --- INSTALL.md | 36 +++++++++++++++++++++++++++++++----- 1 file changed, 31 insertions(+), 5 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 746613c777..1af37861f5 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -38,10 +38,12 @@ You now have the choice between two different environments to use to build the p Press 'Y' when prompted to confirm the installation. -4. Continue with the [building instructions](#Downloading_the_repository). Make sure to always use the plain MSYS environment, other environments will not work. +4. Continue with the [building instructions](#2-downloading-the-repository). Make sure to always use the plain MSYS environment, other environments will not work. ### Windows Subsystem for Linux +***NOTE***: These instructions are written for WSL version 1; if you are using WSL version 2, follow the instructions below for [Linux](#linux). + 1. Open [Windows Powershell **as Administrator**](https://i.imgur.com/QKmVbP9.png), and run the following command (Right Click or Shift+Insert is paste in the Powershell). ```powershell @@ -76,7 +78,7 @@ You now have the choice between two different environments to use to build the p 7. Certain packages are required to build the repository. Install these packages by running the following command: ```bash - sudo apt install git build-essential binutils-arm-none-eabi gcc-arm-none-eabi + sudo apt install git build-essential binutils-arm-none-eabi gcc-arm-none-eabi ninja-build ``` We are not done yet, the 'meson' package is also necessary, but the version provided by apt is too outdated. To get the most recent meson version, run: @@ -86,12 +88,22 @@ You now have the choice between two different environments to use to build the p pip install --user meson ``` -8. Change to a directory accessible from Windows where you'll store the files, for example: + You may see `pip` respond with a warning saying `"The script meson is installed in '/home//.local/bin', which is not on PATH."` To resolve + such an issue, run the following commands: + + ```bash + echo 'export PATH=":$PATH"' >> ~/.bashrc + source ~/.bashrc + ``` + + Replacing `` with the path mentioned above in the `pip` warning. + +9. Change to a directory accessible from Windows where you'll store the files, for example: ```bash cd /mnt/c/Users/$USER/Desktop ``` -Continue with the [building instructions](#Downloading_the_repository) +Continue with the [building instructions](#2-downloading-the-repository). ## macOS @@ -122,6 +134,13 @@ On macOS Monterey (12) or earlier, you may also need GNU Coreutils installed to brew install coreutils ``` +Finally, export the variable `LM_LICENSE_FILE` with value `/path/to/pokeplatinum/tools/cw/license.dat`, e.g.: + +```bash +echo 'export LM_LICENSE_FILE="/path/to/pokeplatinum/tools/cw/license.dat"' >> ~/.zshrc +source ~/.zshrc +``` + ## Linux Building the ROM requires the following packages. If you cannot find one or more of these using your package distribution, it may be under a different name. @@ -140,7 +159,14 @@ NOTE: On some distros, the meson package provided by the package manager will be meson --version ``` -If your mesion version is older than 1.2.0, follow the instructions at: https://mesonbuild.com/Getting-meson.html to get the most recent version of Meson +If your mesion version is older than 1.2.0, follow the instructions at: https://mesonbuild.com/Getting-meson.html to get the most recent version of Meson. + +Finally, export the variable `LM_LICENSE_FILE` with value `/path/to/pokeplatinum/tools/cw/license.dat`, e.g.: + +```bash +echo 'export LM_LICENSE_FILE="/path/to/pokeplatinum/tools/cw/license.dat"' >> ~/.bashrc +source ~/.bashrc +``` # 2. Downloading the repository