From 3d0f0384237185d4fdab5efedd82d2ae25c1918d Mon Sep 17 00:00:00 2001 From: luckytyphlosion <10688458+luckytyphlosion@users.noreply.github.com> Date: Sat, 28 Nov 2020 11:30:11 -0500 Subject: Add install instructions for repositories which don't have dkp-less support. --- docs/legacy_WSL1_INSTALL.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/legacy_WSL1_INSTALL.md (limited to 'docs') diff --git a/docs/legacy_WSL1_INSTALL.md b/docs/legacy_WSL1_INSTALL.md new file mode 100644 index 000000000..f9ed7b0e2 --- /dev/null +++ b/docs/legacy_WSL1_INSTALL.md @@ -0,0 +1,32 @@ +### 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`. + +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. + +For example, if the package file was saved to **C:\Users\\_\_\Downloads** (the Downloads location for most users), enter this command: + +```bash +cd /mnt/c/Users//Downloads +``` + +(The Windows C:\ drive is called /mnt/c/ in WSL. Replace in the example path with your **Windows** username. Windows path names are case-insensitive so adhereing to capitalization isn't needed) + +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. + +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)). -- cgit v1.2.3 From b9eb605fbf07b0f27917e83b302074abd2f681d0 Mon Sep 17 00:00:00 2001 From: luckytyphlosion <10688458+luckytyphlosion@users.noreply.github.com> Date: Sat, 28 Nov 2020 11:34:03 -0500 Subject: Fix broken header links. --- docs/legacy_WSL1_INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/legacy_WSL1_INSTALL.md b/docs/legacy_WSL1_INSTALL.md index f9ed7b0e2..5e2a7e167 100644 --- a/docs/legacy_WSL1_INSTALL.md +++ b/docs/legacy_WSL1_INSTALL.md @@ -29,4 +29,4 @@ Run the following command to set devkitPro related environment variables (altern ```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)). +Proceed to [Choosing where to store pokeemerald (WSL1) of the current INSTALL.md](/INSTALL.md#choosing-where-to-store-pokeemerald-WSL1). -- cgit v1.2.3 From 47d4ff24483abbd416598055f8a5867ff7723378 Mon Sep 17 00:00:00 2001 From: luckytyphlosion <10688458+luckytyphlosion@users.noreply.github.com> Date: Sat, 28 Nov 2020 11:38:02 -0500 Subject: Add case for downloads folder with space for the legacy WSL1 instructions, also fix WSL1 path in dedicated folder example with spaces. --- docs/legacy_WSL1_INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/legacy_WSL1_INSTALL.md b/docs/legacy_WSL1_INSTALL.md index 5e2a7e167..731b8f433 100644 --- a/docs/legacy_WSL1_INSTALL.md +++ b/docs/legacy_WSL1_INSTALL.md @@ -15,7 +15,7 @@ For example, if the package file was saved to **C:\Users\\_\_\Downloads** cd /mnt/c/Users//Downloads ``` -(The Windows C:\ drive is called /mnt/c/ in WSL. Replace in the example path with your **Windows** username. Windows path names are case-insensitive so adhereing to capitalization isn't needed) +(The Windows C:\ drive is called /mnt/c/ in WSL. Replace 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//Downloads folder"`. Windows path names are case-insensitive so adhereing to capitalization isn't needed) Once the directory has been changed to the folder containing the devkitPro package, run the following commands to install devkitPro. ```bash -- cgit v1.2.3 From 9da0920969a31bee441ba941263836204ff85f52 Mon Sep 17 00:00:00 2001 From: luckytyphlosion <10688458+luckytyphlosion@users.noreply.github.com> Date: Wed, 23 Dec 2020 18:02:30 -0500 Subject: 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. --- docs/legacy_WSL1_INSTALL.md | 55 ++++++++++++++++++++++++++------------------- 1 file changed, 32 insertions(+), 23 deletions(-) (limited to 'docs') 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\\_\_\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//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 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//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\\_\_\Downloads** (the Downloads location for most users), enter this command, where *\* 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//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//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). -- cgit v1.2.3 From 1760d6801074ff20568726beeaea4d539aa9f1bd Mon Sep 17 00:00:00 2001 From: luckytyphlosion <10688458+luckytyphlosion@users.noreply.github.com> Date: Mon, 8 Feb 2021 12:39:43 -0500 Subject: Fix up dkP related naming here as well. --- docs/legacy_WSL1_INSTALL.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/legacy_WSL1_INSTALL.md b/docs/legacy_WSL1_INSTALL.md index f848abf67..b9840d1c8 100644 --- a/docs/legacy_WSL1_INSTALL.md +++ b/docs/legacy_WSL1_INSTALL.md @@ -7,7 +7,7 @@ ``` > Note: If the above command does not work, try the above command but replacing `apt` with `apt-get`. -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`. +2. Once the packages have finished installing, download the devkitPro pacman package [here](https://github.com/devkitPro/pacman/releases). The file to download is `devkitpro-pacman.amd64.deb`. 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. @@ -21,7 +21,7 @@ > Note 2: If the path has spaces, then the path must be wrapped with quotations, e.g. `cd "/mnt/c/users//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. +4. Once the directory has been changed to the folder containing the devkitPro pacman package, run the following commands to install devkitARM. ```bash sudo gdebi devkitpro-pacman.amd64.deb -- cgit v1.2.3