summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorluckytyphlosion <10688458+luckytyphlosion@users.noreply.github.com>2020-12-23 18:02:30 -0500
committerluckytyphlosion <10688458+luckytyphlosion@users.noreply.github.com>2020-12-23 18:02:30 -0500
commit9da0920969a31bee441ba941263836204ff85f52 (patch)
tree67e17ea11f97fa9f9fcdd4e6030ccf55be03ad5d /docs
parent2fd2573c4d4e18641fc2f8e83e8176e2810c33eb (diff)
Improve INSTALL.mds as per recommendations.
- Put "conditional" notes in quotes to better communicate which instructions are more required - Number instructions per OS as per Griffin's advice.
Diffstat (limited to 'docs')
-rw-r--r--docs/legacy_WSL1_INSTALL.md55
1 files changed, 32 insertions, 23 deletions
diff --git a/docs/legacy_WSL1_INSTALL.md b/docs/legacy_WSL1_INSTALL.md
index 731b8f433..f848abf67 100644
--- a/docs/legacy_WSL1_INSTALL.md
+++ b/docs/legacy_WSL1_INSTALL.md
@@ -1,32 +1,41 @@
### Setting up WSL1 (Legacy Portion)
-Certain packages are required to build pokeemerald. Install these packages by running the following command:
-```bash
-sudo apt install build-essential git libpng-dev gdebi-core
-```
-(If the above command does not work, try the above command but replacing `apt` with `apt-get`).
-Download the devkitPro software package [here](https://github.com/devkitPro/pacman/releases). The file to download is `devkitpro-pacman.amd64.deb`.
+1. Certain packages are required to build pokeemerald. Install these packages by running the following command:
-WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. To install the devkitPro package, you'll need to change to the **current working directory** where the package file was saved.
+ ```bash
+ sudo apt install build-essential git libpng-dev gdebi-core
+ ```
+ > Note: If the above command does not work, try the above command but replacing `apt` with `apt-get`.
-For example, if the package file was saved to **C:\Users\\_\<user>_\Downloads** (the Downloads location for most users), enter this command:
+2. Once the packages have finished installing, download the devkitPro software package [here](https://github.com/devkitPro/pacman/releases). The file to download is `devkitpro-pacman.amd64.deb`.
-```bash
-cd /mnt/c/Users/<user>/Downloads
-```
+3. WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. To install the devkitPro package, you'll need to change to the **current working directory** where the package file was saved.
-(The Windows C:\ drive is called /mnt/c/ in WSL. Replace <user> in the example path with your **Windows** username. If the path has spaces, then the path must be wrapped with quotations, e.g. `cd "/mnt/c/users/<user>/Downloads folder"`. Windows path names are case-insensitive so adhereing to capitalization isn't needed)
+ For example, if the package file was saved to **C:\Users\\_\<user>_\Downloads** (the Downloads location for most users), enter this command, where *\<user>* is your **Windows** username:
-Once the directory has been changed to the folder containing the devkitPro package, run the following commands to install devkitPro.
-```bash
-sudo gdebi devkitpro-pacman.amd64.deb
-sudo dkp-pacman -Sy
-sudo dkp-pacman -S gba-dev
-```
-Note: the last command will ask for the selection of packages to install. Just press Enter to install all of them, followed by entering Y to proceed with the installation. `devkitpro-pacman.amd64.deb` is the expected filename of the devkitPro package downloaded (for the first command). If the downloaded package filename differs, then use that filename instead.
+ ```bash
+ cd /mnt/c/Users/<user>/Downloads
+ ```
+
+ > Note 1: The Windows C:\ drive is called /mnt/c/ in WSL.
+ > Note 2: If the path has spaces, then the path must be wrapped with quotations, e.g. `cd "/mnt/c/users/<user>/Downloads folder"`.
+ > Note 3: Windows path names are case-insensitive so adhering to capitalization isn't needed
+
+4. Once the directory has been changed to the folder containing the devkitPro package, run the following commands to install devkitPro.
+
+ ```bash
+ sudo gdebi devkitpro-pacman.amd64.deb
+ sudo dkp-pacman -Sy
+ sudo dkp-pacman -S gba-dev
+ ```
+
+ The last command will ask for the selection of packages to install. Just press Enter to install all of them, followed by entering Y to proceed with the installation.
+
+ > Note: `devkitpro-pacman.amd64.deb` is the expected filename of the devkitPro package downloaded (for the first command). If the downloaded package filename differs, then use that filename instead.
+
+5. Run the following command to set devkitPro related environment variables (alternatively, close and re-open WSL):
+ ```bash
+ source /etc/profile.d/devkit-env.sh
+ ```
-Run the following command to set devkitPro related environment variables (alternatively, close and re-open WSL):
-```bash
-source /etc/profile.d/devkit-env.sh
-```
Proceed to [Choosing where to store pokeemerald (WSL1) of the current INSTALL.md](/INSTALL.md#choosing-where-to-store-pokeemerald-WSL1).