Skip to content

Commit

Permalink
Merge pull request #23 from etdv-thevoid/issue18
Browse files Browse the repository at this point in the history
Update INSTALL.md to reference this repo instead of default pret pokered
  • Loading branch information
dannye authored Apr 20, 2024
2 parents 29ed0e0 + 35eeb16 commit 609e7a1
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -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 **pokered-gbc**, 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)).

Expand All @@ -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 pokered-gbc 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 pokered-gbc in **C:\Users\\*\<user>*\Desktop**, enter this command:

```bash
cd /mnt/c/Users/<user>/Desktop
Expand Down Expand Up @@ -48,17 +48,17 @@ 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 pokered-gbc 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 pokered-gbc in **C:\Users\\*\<user>*\Desktop**:

```bash
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 **pokered-gbc**](#build-pokered-gbc).


## macOS
Expand All @@ -69,7 +69,7 @@ Open **Terminal** and prepare to enter commands.

Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#pre-built) for macOS to install **rgbds 0.6.1**.

Now you're ready to [build **pokered**](#build-pokered).
Now you're ready to [build **pokered-gbc**](#build-pokered-gbc).


## Linux
Expand All @@ -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 **pokered-gbc**:

```bash
sudo apt-get install make gcc git
Expand All @@ -88,7 +88,7 @@ Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building

### OpenSUSE

To install the software required for **pokered**:
To install the software required for **pokered-gbc**:

```bash
sudo zypper install make gcc git
Expand All @@ -98,7 +98,7 @@ Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building

### Arch Linux

To install the software required for **pokered**:
To install the software required for **pokered-gbc**:

```bash
sudo pacman -S make gcc git rgbds
Expand All @@ -108,7 +108,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 **pokered-gbc**:

```bash
sudo apt install make clang git sed
Expand All @@ -133,16 +133,16 @@ 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#building-from-source) to build **rgbds 0.6.1** from source.

Now you're ready to [build **pokered**](#build-pokered).
Now you're ready to [build **pokered-gbc**](#build-pokered-gbc).


## Build pokered
## Build pokered-gbc

To download the **pokered** source files:
To download the **pokered-gbc** source files:

```bash
git clone https://github.com/pret/pokered
cd pokered
git clone https://github.com/dannye/pokered-gbc
cd pokered-gbc
```

To build **pokered.gbc** and **pokeblue.gbc**:
Expand All @@ -153,7 +153,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.6.1 globally. Instead, you can put its files in a directory within pokered, such as `pokered/rgbds-0.6.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.6.1 globally. Instead, you can put its files in a directory within pokered-gbc, such as `pokered-gbc/rgbds-0.6.1/`. Then specify it when you run `make`:

```bash
make RGBDS=rgbds-0.6.1/
Expand Down

0 comments on commit 609e7a1

Please sign in to comment.