moparisthebest/sm64
1
0
Fork 0
mirror of https://github.com/n64decomp/sm64.git synced 2024-12-22 07:38:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix readme formatting

Browse Source
This commit is contained in:
CrepeGoat 2023-09-02 02:55:06 -06:00
parent 9921382a68
commit aca9ea7ac6
1 changed files with 27 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -44,23 +44,27 @@ There are 3 steps to set up a working build.
#### Step 1: Install dependencies
The build system has the following package requirements:
* binutils-mips
* pkgconf
* python3 >= 3.6
* binutils-mips
* pkgconf
* python3 >= 3.6
Dependency installation instructions for common Linux distros are provided below:
##### Debian / Ubuntu
To install build dependencies:
```
```bash
sudo apt install -y binutils-mips-linux-gnu build-essential git pkgconf python3
```
##### Arch Linux
To install build dependencies:
```
```bash
sudo pacman -S base-devel python
```
Install the following AUR packages:
* [mips64-elf-binutils](https://aur.archlinux.org/packages/mips64-elf-binutils) (AUR)
@ -81,11 +85,12 @@ You may also use [Docker](#docker-installation) to handle installing an image wi
For each version (jp/us/eu/sh/cn) for which you want to build a ROM, put an existing ROM at
`./baserom.<VERSION>.z64` for asset extraction.
##### Step 3: Build the ROM
#### Step 3: Build the ROM
Run `make` to build the ROM (defaults to `VERSION=us`).
Other examples:
```
```bash
make VERSION=jp -j4 # build (J) version instead with 4 jobs
make VERSION=eu COMPARE=0 # build (EU) version but do not compare ROM hashes
```
@ -106,14 +111,15 @@ With macOS, you may either use Homebrew or [Docker](#docker-installation).
#### Homebrew
#### Step 1: Install dependencies
##### Step 1: Install dependencies
Install [Homebrew](https://brew.sh) and the following dependencies:
```
```bash
brew update
brew install coreutils make pkg-config tehzz/n64-dev/mips64-elf-binutils
```
#### Step 2: Copy baserom(s) for asset extraction
##### Step 2: Copy baserom(s) for asset extraction
For each version (jp/us/eu/sh/cn) for which you want to build a ROM, put an existing ROM at
`./baserom.<VERSION>.z64` for asset extraction.
@ -122,31 +128,33 @@ For each version (jp/us/eu/sh/cn) for which you want to build a ROM, put an exis
Use Homebrew's GNU make because the version included with macOS is too old.
```
```bash
gmake VERSION=jp -j4 # build (J) version instead with 4 jobs
```
### Docker Installation
#### Docker Installation
#### Create Docker image
##### Create Docker image
After installing and starting Docker, create the docker image. This only needs to be done once.
```
```bash
docker build -t sm64 .
```
#### Build
##### Build
To build, mount the local filesystem into the Docker container and build the ROM with `docker run sm64 make`.
##### macOS example for (U):
```
###### macOS example for (U):
```bash
docker run --rm --mount type=bind,source="$(pwd)",destination=/sm64 sm64 make VERSION=us -j4
```
##### Linux example for (U):
###### Linux example for (U):
For a Linux host, Docker needs to be instructed which user should own the output files:
```
```bash
docker run --rm --mount type=bind,source="$(pwd)",destination=/sm64 --user $UID:$GID sm64 make VERSION=us -j4
```