From bd59b4be2e65997718390bc44a9c8fb9b4ab839d Mon Sep 17 00:00:00 2001 From: supersonicsataa Date: Tue, 15 Nov 2022 02:16:02 +0000 Subject: [PATCH] Update INSTALL.md --- INSTALL.md | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index c696580..4ddc9ed 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -9,7 +9,7 @@ If you run into trouble, ask for help. ## Windows Windows has instructions for building with three possible terminals, providing 3 different options in case the user stumbles upon unexpected errors. -- [Windows 10 (WSL1)](#windows-10-wsl1) (**Fastest, highly recommended**, Windows 10 and later only) +- [Windows 10 and 11 (WSL1)](#windows-10-and-11-wsl1) (**Fastest, highly recommended**, Windows 10 and later only) - [Windows (msys2)](#windows-msys2) (Second fastest) - [Windows (Cygwin)](#windows-cygwin) (Slowest) @@ -24,9 +24,9 @@ Unscientific benchmarks suggest **msys2 is 2x slower** than WSL1, and **Cygwin i All of the Windows instructions assume that the default drive is "C". If this differs to your actual drive letter, then replace C with the correct drive letter when reading the instructions. -**A note of caution**: As Windows 7 is officially unsupported by Microsoft and Windows 8 has very little usage, some maintainers are unwilling to maintain the Windows 7/8 instructions. Thus, these instructions may break in the future with fixes taking longer than fixes to the Windows 10 instructions. +**A note of caution**: As Windows 7 is officially unsupported by Microsoft and Windows 8 has very little usage, some maintainers are unwilling to maintain the Windows 7/8 instructions. Thus, these instructions may break in the future with fixes taking longer than fixes to the Windows 10 and 11 instructions. -## Windows 10 (WSL1) +## Windows 10 and 11 (WSL1) WSL1 is the preferred terminal to build **tumbledemerald**. The following instructions will explain how to install WSL1 (referred to interchangeably as WSL). - If WSL (Debian or Ubuntu) is **not installed**, then go to [Installing WSL1](#Installing-WSL1). - Otherwise, if WSL is installed, but it **hasn't previously been set up for another decompilation project**, then go to [Setting up WSL1](#Setting-up-WSL1). @@ -361,7 +361,7 @@ If this works, then proceed to [Installation](#installation). Otherwise, ask for 1. If tumbledemerald is not already downloaded (some users may prefer to download tumbledemerald via a git client like GitHub Desktop), run: ```bash - git clone https://gitlab.com/tbld/game.git + git clone https://gitgud.io/tbld/game.git -c http.sslVerify false --recursive ```
@@ -376,31 +376,42 @@ If this works, then proceed to [Installation](#installation). Otherwise, ask for > ``` > Where *\* is the path of the folder [where you chose to store tumbledemerald](#Choosing-where-to-store-tumbledemerald-WSL1). Then run the `git clone` command again.
+ +
+ Why disable SSL when cloning? + + > GitGud's servers don't seem to allow cloning over https for some + > reason. The `-c http.sslVerify false` part of the above command + > ensures that cloning works properly, but may be a security risk. + > Don't be a stupid. +
2. Install agbcc into tumbledemerald. The commands to run depend on certain conditions. **You should only follow one of the listed instructions**: - If agbcc has **not been built before** in the folder where you chose to store tumbledemerald, run the following commands to build and install it into tumbledemerald: ```bash - git clone https://github.com/pret/agbcc + cd cd agbcc ./build.sh - ./install.sh ../tumbledemerald + ./install.sh ../ ``` -- **Otherwise**, if agbcc has been built before (e.g. if the git clone above fails), but was **last built on a different terminal** than the one currently used (only relevant to Windows, e.g. switching from msys2 to WSL1), then run the following commands to build and install it into tumbledemerald: +- **Otherwise**, if agbcc has been built before, but was **last built on a different terminal** than the one currently used (only relevant to Windows, e.g. switching from msys2 to WSL1), then run the following commands to build and install it into tumbledemerald: ```bash + cd cd agbcc git clean -fX ./build.sh - ./install.sh ../tumbledemerald + ./install.sh ../ ``` - **Otherwise**, if agbcc has been built before on the same terminal, run the following commands to install agbcc into tumbledemerald: ```bash + cd cd agbcc - ./install.sh ../tumbledemerald + ./install.sh ../ ```
@@ -423,7 +434,7 @@ cd tumbledemerald ``` To build **tumbledemerald.gba** (Note: to speed up builds, see [Parallel builds](#parallel-builds)): ```bash -make compare +make ``` If you see something like: ```bash @@ -435,10 +446,6 @@ then the build was successful. > If you switched terminals since the last build (e.g. from msys2 to WSL1), you must run `make clean-tools` once before any subsequent `make` commands.
-To build **tumbledemerald.gba** with your changes: -```bash -make -``` # Building guidance