Swap old README.txt for informative README.md

Matches the structure of all of our other repositories.
This commit is contained in:
Ian 2022-11-27 12:26:59 -05:00
parent 32b7a3e972
commit ae8f4766e6
2 changed files with 22 additions and 10 deletions

22
README.md Normal file
View file

@ -0,0 +1,22 @@
# Nazi Zombies: Portable glQuake
## About
This repository contains the 3DS engine for NZ:P, based on the glQuake port by masterfeizz. It contains optimizations from the NZ:P Team as well as NZ:P-specific feature implementation.
## Building (Advanced)
Building requires a full install of [libctru](https://github.com/devkitPro/libctru). You can either follow the instructions on the GitHub repository or use a Docker container (we recommend [the official one](devkitpro/devkitarm))!
With the psptoolchain installed, you now need to install the latest `picaGL`, which needs cloned from the official GitHub repository:
```bash
git clone https://github.com/masterfeizz/picaGL.git -b revamp
cd picaGL
mkdir clean
make install
```
Now you can navigate to the root of the repository and build the `.3dsx`.
```bash
make -f Makefile
```
We also provide prebuilt .3dsx files on the [Releases](https://github.com/nzp-team/glquake/releases/tag/bleeding-edge) page.

View file

@ -1,10 +0,0 @@
Credits (By order of importance):
=================================
1. masterfiezz: ctrQuake
2. Diabolickal: HLBSP
3. Havok: Colored lighting
4. Naievil, Motolegacy: Porting
5. Other NZP members