diff options
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 36 |
1 files changed, 18 insertions, 18 deletions
@@ -1,6 +1,6 @@ # Instructions -These instructions explain how to set up the tools required to build **pokered**, including [**rgbds**](https://github.com/gbdev/rgbds), which assembles the source files into a ROM. +These instructions explain how to set up the tools required to build **pokeyellow**, including [**rgbds**](https://github.com/gbdev/rgbds), which assembles the source files into a ROM. If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)). @@ -15,9 +15,9 @@ Update WSL's software before continuing. If you chose Debian, Ubuntu, or another apt-get update && apt-get upgrade ``` -WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install pokered within Windows. You'll have to change the **current working directory** every time you open WSL. +WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install pokeyellow within Windows. You'll have to change the **current working directory** every time you open WSL. -For example, if you want to store pokered in **C:\Users\\*\<user>*\Desktop**, enter this command: +For example, if you want to store pokeyellow in **C:\Users\\*\<user>*\Desktop**, enter this command: ```bash cd /mnt/c/Users/<user>/Desktop @@ -48,9 +48,9 @@ Then follow the [**rgbds** install instructions](https://rgbds.gbdev.io/install/ Now open the **Cygwin terminal** and enter the following commands. -Cygwin has its own file system that's within Windows, at **C:\cygwin64\home\\*\<user>***. If you don't want to store pokered there, you'll have to change the **current working directory** every time you open Cygwin. +Cygwin has its own file system that's within Windows, at **C:\cygwin64\home\\*\<user>***. If you don't want to store pokeyellow there, you'll have to change the **current working directory** every time you open Cygwin. -For example, if you want to store pokered in **C:\Users\\*\<user>*\Desktop**: +For example, if you want to store pokeyellow in **C:\Users\\*\<user>*\Desktop**: ```bash cd /cygdrive/c/Users/<user>/Desktop @@ -58,7 +58,7 @@ cd /cygdrive/c/Users/<user>/Desktop (The Windows `C:\` drive is called `/cygdrive/c/` in Cygwin. Replace *\<user>* in the example path with your username.) -Now you're ready to [build **pokered**](#build-pokered). +Now you're ready to [build **pokeyellow**](#build-pokeyellow). ## macOS @@ -69,7 +69,7 @@ Open **Terminal** and prepare to enter commands. Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/macos) for macOS to install **rgbds 0.5.1**. -Now you're ready to [build **pokered**](#build-pokered). +Now you're ready to [build **pokeyellow**](#build-pokeyellow). ## Linux @@ -78,7 +78,7 @@ Open **Terminal** and enter the following commands, depending on which distro yo ### Debian or Ubuntu -To install the software required for **pokered**: +To install the software required for **pokeyellow**: ```bash sudo apt-get install make gcc git @@ -88,7 +88,7 @@ Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) ### OpenSUSE -To install the software required for **pokered**: +To install the software required for **pokeyellow**: ```bash sudo zypper install make gcc git @@ -98,7 +98,7 @@ Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) ### Arch Linux -To install the software required for **pokered**: +To install the software required for **pokeyellow**: ```bash sudo pacman -S make gcc git @@ -110,7 +110,7 @@ If you want to compile and install **rgbds** yourself instead, then follow the [ ### Termux -To install the software required for **pokered**: +To install the software required for **pokeyellow**: ```bash sudo apt install make clang git sed @@ -135,19 +135,19 @@ If your distro is not listed here, try to find the required software in its repo If `rgbds` is not available, you'll need to follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.5.1** from source. -Now you're ready to [build **pokered**](#build-pokered). +Now you're ready to [build **pokeyellow**](#build-pokeyellow). -## Build pokered +## Build pokeyellow -To download the **pokered** source files: +To download the **pokeyellow** source files: ```bash -git clone https://github.com/pret/pokered -cd pokered +git clone https://github.com/pret/pokeyellow +cd pokeyellow ``` -To build **pokered.gbc** and **pokeblue.gbc**: +To build **pokeyellow.gbc**: ```bash make @@ -155,7 +155,7 @@ make ### Build with a local rgbds version -If you have different projects that require different versions of `rgbds`, it might not be convenient to install rgbds 0.5.1 globally. Instead, you can put its files in a directory within pokered, such as `pokered/rgbds-0.5.1/`. Then specify it when you run `make`: +If you have different projects that require different versions of `rgbds`, it might not be convenient to install rgbds 0.5.1 globally. Instead, you can put its files in a directory within pokeyellow, such as `pokeyellow/rgbds-0.5.1/`. Then specify it when you run `make`: ```bash make RGBDS=rgbds-0.5.1/ |