summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEthan Roseman <ethteck@gmail.com>2020-08-22 19:06:52 -0400
committerGitHub <noreply@github.com>2020-08-22 19:06:52 -0400
commit6f54edd36527245bb6781e5b925ead1578950b49 (patch)
tree2944090764ea05d3e6af8010e0714e520c47f383 /README.md
parent3cb03b2b2f0da72960944171081bba8b6cba6722 (diff)
Ido Static Recomp (#337)
* Ido Recomp test * try 2 * Recomp by default * Fix Jenkinsfile * Fix 2 * CFE errors * CFE fix -O2 * Update Makefile Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * Update README.md Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * Update README.md Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * PR suggestions * PR updates Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index 5015cf3ad..deb590eeb 100644
--- a/README.md
+++ b/README.md
@@ -55,22 +55,22 @@ sudo apt-get update
sudo apt-get install git build-essential binutils-mips-linux-gnu python3
```
-#### 2. Download qemu-irix
+#### 2. Download and set up qemu-irix (optional)
-Download qemu-irix from the Releases section in the repository. Place it at a location of your choosing.
+Note: We are currently testing a recompiled version of the compiler that does not require qemu-irix.
+This step allows you to build with qemu-irix and the original compiler by adding `ORIG_COMPILER=1` to the `make` command in step 6, for example if you experience issues with the recompiled version.
-#### 3. Set environment variables
+Download qemu-irix from the Releases section in the repository. Place it at a location of your choosing.
Open up your .bashrc file (~/.bashrc), scroll to the bottom, and add the following, replacing the paths as necessary:
```text
export QEMU_IRIX="path/to/your/qemu-irix"
-export MIPS_BINUTILS_PREFIX=mips-linux-gnu-
```
Save and close/reopen your terminal window.
-#### 4. Clone the repository
+#### 3. Clone the repository
Clone `https://github.com/zeldaret/oot.git` where you wish to have the project, with a command such as:
@@ -78,12 +78,12 @@ Clone `https://github.com/zeldaret/oot.git` where you wish to have the project,
git clone https://github.com/zeldaret/oot.git
```
-#### 5. Prepare a base ROM
+#### 4. Prepare a base ROM
Copy over your copy of the Master Quest (Debug) ROM inside the root of this new project directory.
Rename the file to "baserom_original.z64" or "baserom_original.n64", depending on the original extension.
-#### 6. Setup the ROM and build process
+#### 5. Setup the ROM and build process
Setup and extract everything from your ROM with the following command:
@@ -94,7 +94,7 @@ make setup
This will generate a new ROM called "baserom.z64" that will have the overdump removed and the header patched.
It will also extract the individual assets from the ROM.
-#### 7. Build the ROM
+#### 6. Build the ROM
Run make to build the ROM.
Make sure your path to the project is not too long, otherwise this process may error.