From 1bb9a2eb0b51cd30bb415f8e1522ff3295cfa3a8 Mon Sep 17 00:00:00 2001 From: Kenix3 Date: Wed, 24 Feb 2021 23:50:40 -0500 Subject: [PATCH] Updated Installation (markdown) --- Installation.md | 53 +++++++++++++++++++++---------------------------- 1 file changed, 23 insertions(+), 30 deletions(-) diff --git a/Installation.md b/Installation.md index e8d4193..5c5099b 100644 --- a/Installation.md +++ b/Installation.md @@ -26,43 +26,17 @@ sudo apt-get install python3-pip ``` ## Step 3: -- Download build_tools.zip from the [Releases](https://github.com/zeldaret/mm/releases/) section. -- Extract build_tools.zip to the `/path/to/mm/tools` folder. -- This contains the compilers the decompilation uses, as well as a modified version of Qemu to emulate them on a modern Linux system. -- The compilers must go into the tools folder. Qemu may be placed wherever you like. If Qemu is not in the builds folder, then you will need to set the correct path in Step 4. - -## Step 4: -### Option A -Open up your .bashrc file (~/.bashrc), scroll to the bottom, and add the following, replacing `/path/to/qemu-mips` with the location the qemu-mips you extracted from the build tools: - -``` -export QEMU_IRIX="/path/to/qemu-mips" -``` - -Save and close/reopen your terminal window. -### Option B -Ensure that `QEMU_IRIX` is not a defined environment variable. -Copy `qemu-mips`to `/path/to/repository/tools/qemu-mips` - -## Step 5: Make a fork of the main repository https://github.com/zeldaret/mm.git and clone your fork. -## Step 6: +## Step 4: You will need to acquire a copy of the ROM. The md5 of this ROM should be `2a0a8acb61538235bc1094d297fb6556`. -Once this has been done, type, replacing `` with the name of your ROM: -``` -./tools/extract_rom.py -``` - -This will extract all the individual files in the ROM into a newly created baserom folder, as well as decompress the compressed files in a newly created decomp folder. - -Next, type: +Run the command ``` make init ``` - +This will extract all the individual files in the ROM into a newly created baserom folder, as well as decompress the compressed files in a newly created decomp folder. This will create the build folders as well as a newly created asm folder containing the disassemblies of nearly all the files containing code. This make target will also build the ROM. You should see the following text printed: @@ -80,4 +54,23 @@ The `make init` target will also copy the successful build to the `./expected` d This command can be used to invoke the diff script in order to aid in decompiling functions: `./tools/asm-differ/diff.py -wmo {function_name}` -Happy decompiling! \ No newline at end of file +Happy decompiling! + +## Step 5 (Optional): +- Download build_tools.zip from the [Releases](https://github.com/zeldaret/mm/releases/) section. +- Extract build_tools.zip to the `/path/to/mm/tools` folder. +- This contains the compilers the decompilation uses, as well as a modified version of Qemu to emulate them on a modern Linux system. +- The compilers must go into the tools folder. Qemu may be placed wherever you like. If Qemu is not in the builds folder, then you will need to set the correct path in Step 6. + +## Step 6 (Optional): +### Option A +Open up your .bashrc file (~/.bashrc), scroll to the bottom, and add the following, replacing `/path/to/qemu-mips` with the location the qemu-mips you extracted from the build tools: + +``` +export QEMU_IRIX="/path/to/qemu-mips" +``` + +Save and close/reopen your terminal window. +### Option B +Ensure that `QEMU_IRIX` is not a defined environment variable. +Copy `qemu-mips`to `/path/to/repository/tools/qemu-mips` \ No newline at end of file