falso
/
mm
mirror of https://github.com/zeldaret/mm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update Readme (#765) 

* Update

* Update MacOS instructions

* forgot .

* New python step

* typo
This commit is contained in:
Derek Hensley 2022-03-29 08:19:59 -07:00 committed by GitHub
parent 84d9efda92
commit 9582a3e79f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -50,7 +50,7 @@ We recommend using Debian or Ubuntu 20.04 Linux distributions.
### MacOS ### MacOS
Preparation is covered in a [separate document](docsBUILDING_MACOS.md). Preparation is covered in a [separate document](docs/BUILDING_MACOS.md).
### Linux (Native or under WSL / VM) ### Linux (Native or under WSL / VM)
@ -74,13 +74,7 @@ sudo apt update
sudo apt install make git build-essential binutils-mips-linux-gnu python3 python3-pip libpng-dev sudo apt install make git build-essential binutils-mips-linux-gnu python3 python3-pip libpng-dev
``` ```
To install the Python dependencies simply run in a terminal: #### 2. Clone the repository
```bash
python3 -m pip install -r requirements.txt
```
#### 2. Fork the repository
Create your own fork of the repository at `https://github.com/zeldaret/mm`. Then clone your fork where you wish to have the project, with the command: Create your own fork of the repository at `https://github.com/zeldaret/mm`. Then clone your fork where you wish to have the project, with the command:
@ -88,11 +82,27 @@ Create your own fork of the repository at `https://github.com/zeldaret/mm`. Then
git clone https://github.com/<YOUR_USERNAME>/mm.git git clone https://github.com/<YOUR_USERNAME>/mm.git
``` ```
#### 3. Prepare a base ROM This will copy the GitHub repository contents into a new folder in the current directory called `mm`. Change into this directory before doing anything else:
```bash
cd mm
```
#### 3. Install python dependencies
The build process has a few python packages required that are located in `requirements.txt`.
To install them simply run in a terminal:
```bash
python3 -m pip install -r requirements.txt
```
#### 4. Prepare a base ROM
Copy your ROM to inside the root of this new project directory, and rename the file of the baserom to reflect the version of ROM you are using. ex: `baserom.mm.us.rev1.z64` Copy your ROM to inside the root of this new project directory, and rename the file of the baserom to reflect the version of ROM you are using. ex: `baserom.mm.us.rev1.z64`
#### 4. Make and Build the ROM #### 5. Make and Build the ROM
To start the extraction/build process, run the following command: To start the extraction/build process, run the following command:

2
docs/BUILDING_MACOS.md
View File

@ -80,4 +80,4 @@ If this worked, you can now delete the temporary directory `~/binutils-tmp`.
Apple's version of `make` is very out-of-date, so you should use the brew-installed `gmake` in place of `make` in this repo from now on. Apple's version of `make` is very out-of-date, so you should use the brew-installed `gmake` in place of `make` in this repo from now on.
You should now be able to continue from [step 2](README.md#2-clone-the-repository) of the Linux instructions. You should now be able to continue from [step 2](../README.md#2-clone-the-repository) of the Linux instructions.