Future/pokecrystal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
Added windows 10 (WSL) installation instructions and expanded linux instructions.
Clarified things in FAQ.md.
This commit is contained in:
mid-kid
2018-08-30 03:14:39 +02:00
parent a71b28e5b7
commit 1070115087
2 changed files with 129 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

149
INSTALL.md
View File

@@ -6,63 +6,44 @@ 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)).
## Linux
## Windows 10
```bash
sudo apt-get install make gcc bison git libpng-dev
Set up/install [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
git clone https://github.com/rednex/rgbds
cd rgbds
sudo make install
cd ..
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.
git clone https://github.com/pret/pokecrystal
cd pokecrystal
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 your pokecrystal in `C:\Users\<user>\Desktop`:
```
cd /mnt/c/Users/<user>/Desktop
```
To build **pokecrystal.gbc**:
(Replace `<user>` with your username.)
```bash
make
```
You will have to run this command each time you open WSL.
Follow [the instructions for Linux](#linux) to complete the installation.
## Mac
In **Terminal**, run:
```bash
xcode-select --install
git clone https://github.com/rednex/rgbds
cd rgbds
sudo make install
cd ..
git clone https://github.com/pret/pokecrystal
cd pokecrystal
```
To build **pokecrystal.gbc**:
```bash
make
```
If this doesn't work, try following the regular Windows installation instructions below.
## Windows
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:
Run setup and leave the default settings. At "Select Packages", choose to install the following, all of which are in the "Devel" category:
- `make`
- `git`
- `gcc-core`
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**.
Click once on the text that says "Skip" next to each package to select the most recent version to install.
**Note: If you have an older rgbds, you will need to update to 0.3.3 or newer.** Ignore this if you have never installed rgbds before.
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.
In the **Cygwin terminal**, enter these commands:
@@ -71,6 +52,8 @@ git clone https://github.com/pret/pokecrystal
cd pokecrystal
```
The files will be stored in **C:\cygwin64\home\<user>**.
To build **pokecrystal.gbc**:
```bash
@@ -82,3 +65,95 @@ To build **pokecrystal11.gbc**:
```bash
make crystal11
```
## Mac
In **Terminal**, run:
```bash
xcode-select --install
git clone --depth=1 https://github.com/rednex/rgbds
cd rgbds
sudo make CFLAGS=-O2 install
cd ..
git clone https://github.com/pret/pokecrystal
cd pokecrystal
```
To build **pokecrystal.gbc**:
```bash
make
```
## Linux
### Install the required software
#### Debian/Ubuntu
```bash
sudo apt-get install make gcc bison git libpng-dev
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
#### OpenSUSE
```bash
sudo zypper install make gcc bison git libpng16-devel
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
#### Arch Linux
```bash
sudo pacman -S make gcc bison git libpng
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
#### Termux
```bash
sudo apt install make clang git rgbds sed
```
#### Other distros
If your distro is not listed here, try to find the required software in the repositories:
- `make`
- `gcc` (or `clang`)
- `git`
- `rgbds`
To build `rgbds` from source, if not available for your distro, you need, additionally:
- `bison`
- `libpng` (and the development headers)
And run the following commands:
```bash
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
### Download and build the code
```bash
git clone https://github.com/pret/pokecrystal
cd pokecrystal
```
To build **pokecrystal.gbc**:
```bash
make
```