mirror of https://github.com/pret/pokecrystal.git
Revise documentation
All the INSTALL.md sections have similar structure
This commit is contained in:
parent
963026695d
commit
cd169aec3c
2
FAQ.md
2
FAQ.md
|
@ -52,7 +52,7 @@ Run `make clean` to remove all the old `o` files, then re-run `make`.
|
||||||
|
|
||||||
You've made a mistake while writing some of the code. Re-read the modifications you've made to the file it complains about and try to compare them with other code.
|
You've made a mistake while writing some of the code. Re-read the modifications you've made to the file it complains about and try to compare them with other code.
|
||||||
|
|
||||||
If you're not using the latest version of [**rgbds**](https://github.com/rednex/rgbds/releases), update this as well. Don't forget to `make clean` afterwards.
|
If you're not using the latest version of [**rgbds**][rgbds], update this as well. Don't forget to `make clean` afterwards.
|
||||||
|
|
||||||
|
|
||||||
## How do I edit maps?
|
## How do I edit maps?
|
||||||
|
|
143
INSTALL.md
143
INSTALL.md
|
@ -1,59 +1,68 @@
|
||||||
# Instructions
|
# Instructions
|
||||||
|
|
||||||
The source files are assembled into a ROM using [**rgbds**](https://github.com/rednex/rgbds).
|
These instructions explain how to set up the tools required to build **pokecrystal**, including [**rgbds**](https://github.com/rednex/rgbds), which assembles the source files into a ROM.
|
||||||
These instructions explain how to set up the tools required to build.
|
|
||||||
|
|
||||||
If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)).
|
If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)).
|
||||||
|
|
||||||
|
|
||||||
## Windows 10
|
## Windows 10
|
||||||
|
|
||||||
Set up/install [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
|
Download and install [**Windows Subsystem for Linux**](https://docs.microsoft.com/en-us/windows/wsl/install-win10). Then open the **WSL terminal**.
|
||||||
|
|
||||||
WSL has its own file system that's not accessible from Windows, but the Windows file system, *is* accessible from WSL. So you're going to want to install pokecrystal within the Windows file system.
|
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 pokecrystal within Windows. You'll have to change the **current working directory** every time you open WSL.
|
||||||
|
|
||||||
The Windows `C:\` drive is called `/mnt/c/` in WSL. You will have to change the current working directory to within `/mnt/c/` every time you open WSL.
|
For example, if you want to store pokecrystal in **C:\Users\\*\<user>*\Desktop**, enter this command:
|
||||||
|
|
||||||
For example, if you want your pokecrystal in `C:\Users\<user>\Desktop`:
|
```bash
|
||||||
|
|
||||||
```
|
|
||||||
cd /mnt/c/Users/<user>/Desktop
|
cd /mnt/c/Users/<user>/Desktop
|
||||||
```
|
```
|
||||||
|
|
||||||
(Replace `<user>` with your username.)
|
(The Windows `C:\` drive is called `/mnt/c/` in WSL. Replace *\<user>* in the example path with your username.)
|
||||||
|
|
||||||
You will have to run this command each time you open WSL.
|
Then follow [the instructions for **Linux**](#linux) to build **pokecrystal**.
|
||||||
|
|
||||||
Follow [the instructions for Linux](#linux) to complete the installation.
|
If this doesn't work, try following [the regular Windows instructions](#windows) below.
|
||||||
|
|
||||||
If this doesn't work, try following the regular Windows installation instructions below.
|
|
||||||
|
|
||||||
|
|
||||||
## Windows
|
## Windows
|
||||||
|
|
||||||
|
### 1. Install the required software
|
||||||
|
|
||||||
Download [**Cygwin**](http://cygwin.com/install.html): **setup-x86_64.exe** for 64-bit Windows, **setup-x86.exe** for 32-bit.
|
Download [**Cygwin**](http://cygwin.com/install.html): **setup-x86_64.exe** for 64-bit Windows, **setup-x86.exe** for 32-bit.
|
||||||
|
|
||||||
Run setup and leave the default settings. At "Select Packages", choose to install the following, all of which are in the "Devel" category:
|
Run setup and leave the default settings. At the "**Select Packages**" step, choose to install the following, all of which are in the "**Devel**" category:
|
||||||
|
|
||||||
- `make`
|
- `make`
|
||||||
- `git`
|
- `git`
|
||||||
- `gcc-core`
|
- `gcc-core`
|
||||||
|
|
||||||
Click once on the text that says "Skip" next to each package to select the most recent version to install.
|
Click once on the text that says "**Skip**" next to each package to select the most recent version to install.
|
||||||
|
|
||||||
Then download [**rgbds**](https://github.com/rednex/rgbds/releases/): the latest **win64.zip** or **win32.zip** release. Extract it and put all the `exe` and `dll` files individually in **C:\cygwin64\usr\local\bin**.
|
Then download [**rgbds**](https://github.com/rednex/rgbds/releases/): the latest **win64.zip** or **win32.zip** release. Extract it and put all the `exe` and `dll` files individually in **C:\cygwin64\usr\local\bin**.
|
||||||
|
|
||||||
**Note: If you have an older rgbds, you will need to update to 0.3.7 or newer.** Ignore this if you have never installed rgbds before.
|
**Note: If you already have an older rgbds, you will need to update to 0.3.7 or newer.** Ignore this if you have never installed rgbds before.
|
||||||
|
|
||||||
In the **Cygwin terminal**, enter these commands:
|
### 2. Build pokecrystal
|
||||||
|
|
||||||
|
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 pokecrystal there, you'll have to change the **current working directory** every time you open Cygwin.
|
||||||
|
|
||||||
|
For example, if you want to store pokecrystal 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.)
|
||||||
|
|
||||||
|
To download **pokecrystal**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/pret/pokecrystal
|
git clone https://github.com/pret/pokecrystal
|
||||||
cd pokecrystal
|
cd pokecrystal
|
||||||
```
|
```
|
||||||
|
|
||||||
The files will be stored in **C:\cygwin64\home\<user>**.
|
|
||||||
|
|
||||||
To build **pokecrystal.gbc**:
|
To build **pokecrystal.gbc**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -67,18 +76,30 @@ make crystal11
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Mac
|
## Mac OS X
|
||||||
|
|
||||||
In **Terminal**, run:
|
Open **Terminal** and enter the following commands.
|
||||||
|
|
||||||
|
### 1. Install the required software
|
||||||
|
|
||||||
|
To install the **Xcode Command Line Tools**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
xcode-select --install
|
xcode-select --install
|
||||||
|
```
|
||||||
|
|
||||||
|
To install **rgbds**:
|
||||||
|
|
||||||
|
```bash
|
||||||
git clone --depth=1 https://github.com/rednex/rgbds
|
git clone --depth=1 https://github.com/rednex/rgbds
|
||||||
cd rgbds
|
sudo make -C rgbds CFLAGS=-O2 install
|
||||||
sudo make CFLAGS=-O2 install
|
```
|
||||||
cd ..
|
|
||||||
|
|
||||||
|
### 2. Build pokecrystal
|
||||||
|
|
||||||
|
To download **pokecrystal**:
|
||||||
|
|
||||||
|
```bash
|
||||||
git clone https://github.com/pret/pokecrystal
|
git clone https://github.com/pret/pokecrystal
|
||||||
cd pokecrystal
|
cd pokecrystal
|
||||||
```
|
```
|
||||||
|
@ -89,63 +110,107 @@ To build **pokecrystal.gbc**:
|
||||||
make
|
make
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To build **pokecrystal11.gbc**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make crystal11
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Linux
|
## Linux
|
||||||
|
|
||||||
### Install the required software
|
Open **Terminal** and enter the following commands.
|
||||||
|
|
||||||
#### Debian/Ubuntu
|
### 1. Install the required software
|
||||||
|
|
||||||
|
The commands to do this depend on which distro you're using.
|
||||||
|
|
||||||
|
#### Debian or Ubuntu
|
||||||
|
|
||||||
|
To install the software required for **pokecrystal**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo apt-get install make gcc bison git libpng-dev
|
sudo apt-get install make gcc git
|
||||||
|
```
|
||||||
|
|
||||||
|
To install **rgbds**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt-get install bison libpng-dev
|
||||||
git clone --depth=1 https://github.com/rednex/rgbds
|
git clone --depth=1 https://github.com/rednex/rgbds
|
||||||
sudo make -C rgbds CFLAGS=-O2 install
|
sudo make -C rgbds CFLAGS=-O2 install
|
||||||
```
|
```
|
||||||
|
|
||||||
#### OpenSUSE
|
#### OpenSUSE
|
||||||
|
|
||||||
```bash
|
To install the software required for **pokecrystal**:
|
||||||
sudo zypper install make gcc bison git libpng16-devel
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo zypper install make gcc git
|
||||||
|
```
|
||||||
|
|
||||||
|
To install **rgbds**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo zypper install bison libpng16-devel
|
||||||
git clone --depth=1 https://github.com/rednex/rgbds
|
git clone --depth=1 https://github.com/rednex/rgbds
|
||||||
sudo make -C rgbds CFLAGS=-O2 install
|
sudo make -C rgbds CFLAGS=-O2 install
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Arch Linux
|
#### Arch Linux
|
||||||
|
|
||||||
```bash
|
To install the software required for **pokecrystal**:
|
||||||
sudo pacman -S make gcc bison git libpng
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo pacman -S make gcc git
|
||||||
|
```
|
||||||
|
|
||||||
|
To install **rgbds**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo pacman -S bison libpng
|
||||||
git clone --depth=1 https://github.com/rednex/rgbds
|
git clone --depth=1 https://github.com/rednex/rgbds
|
||||||
sudo make -C rgbds CFLAGS=-O2 install
|
sudo make -C rgbds CFLAGS=-O2 install
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Termux
|
#### Termux
|
||||||
|
|
||||||
|
To install the software required for **pokecrystal**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo apt install make clang git rgbds sed
|
sudo apt install make clang git sed
|
||||||
|
```
|
||||||
|
|
||||||
|
To install **rgbds**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt install rgbds
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Other distros
|
#### Other distros
|
||||||
|
|
||||||
If your distro is not listed here, try to find the required software in the repositories:
|
If your distro is not listed here, try to find the required software in its repositories:
|
||||||
|
|
||||||
- `make`
|
- `make`
|
||||||
- `gcc` (or `clang`)
|
- `gcc` (or `clang`)
|
||||||
- `git`
|
- `git`
|
||||||
- `rgbds`
|
- `rgbds`
|
||||||
|
|
||||||
To build `rgbds` from source, if not available for your distro, you need, additionally:
|
If `rgbds` is not available, you'll also need these:
|
||||||
|
|
||||||
- `bison`
|
- `bison`
|
||||||
- `libpng` (and the development headers)
|
- `libpng` (and the development headers)
|
||||||
|
|
||||||
And run the following commands:
|
To install **rgbds**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone --depth=1 https://github.com/rednex/rgbds
|
git clone --depth=1 https://github.com/rednex/rgbds
|
||||||
sudo make -C rgbds CFLAGS=-O2 install
|
sudo make -C rgbds CFLAGS=-O2 install
|
||||||
```
|
```
|
||||||
|
|
||||||
### Download and build the code
|
### 2. Build pokecrystal
|
||||||
|
|
||||||
|
To download **pokecrystal**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/pret/pokecrystal
|
git clone https://github.com/pret/pokecrystal
|
||||||
|
@ -157,3 +222,9 @@ To build **pokecrystal.gbc**:
|
||||||
```bash
|
```bash
|
||||||
make
|
make
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To build **pokecrystal11.gbc**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make crystal11
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in New Issue