diff options
| author | Parker Burnett <burnettparker@gmail.com> | 2022-07-11 17:27:49 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-11 20:27:49 -0400 |
| commit | 3503163a640cd19f1788a58ec5abb7a57ea53b2c (patch) | |
| tree | 1c6bb3b7b375818b9f5f91a094ed5b27d5a9f56f /README.md | |
| parent | 54957f8735051610ba97d40467dd008fa1870ca2 (diff) | |
Adding Git information to tutorial (#862)
* Adding an intro to git with helpful commands for someone unfamiliar
with git.
Co-authored by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
* Adding an intro to git with helpful commands for someone unfamiliar
with git.
Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
* ovl_Obj_Y2lift decompiled (#856)
* ovl_Obj_Y2lift decompiled
* format
* pr review fixes
* clean up
Co-authored-by: SonicDcer <noreply@github.com>
* Formating files and moving contributing.md
Also fixes links.
* Adding an intro to git with helpful commands for someone unfamiliar
with git.
formating files too
Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
* pr fixes
Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
Co-authored-by: Alejandro Asenjo <96613413+sonicdcer@users.noreply.github.com>
Co-authored-by: SonicDcer <noreply@github.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 4 insertions, 7 deletions
@@ -34,10 +34,9 @@ It currently builds the following ROM: Please refer to the following for more information: -- [Website](https://zelda64.dev/) -- [Discord](https://discord.zelda64.dev/) -- [How to Contribute](CONTRIBUTING.md) - +* [Website](https://zelda64.dev/) +* [Discord](https://discord.zelda64.dev/) +* [How to Contribute](docs/CONTRIBUTING.md) ## Installation @@ -47,12 +46,10 @@ For Windows 10, install WSL and a distribution by following this [Windows Subsystem for Linux Installation Guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10). We recommend using Debian or Ubuntu 20.04 Linux distributions. - ### MacOS Preparation is covered in a [separate document](docs/BUILDING_MACOS.md). - ### Linux (Native or under WSL / VM) #### 1. Install build dependencies @@ -129,7 +126,7 @@ This means that something is wrong with the ROM's contents. Either the baserom f Running `make init` will also make the `./expected` directory and copy all of the files there, which will be useful when running the diff script. The diff script is useful in decompiling functions and can be ran with this command: `./tools/asm-differ/diff.py -wmo3 <insert_function_here>` -**Note**: to speed up the build, you can pass `-jN` to `make setup` and `make`, where N is the number of threads to use in the build, e.g. `make -j4`. The generally-accepted wisdom is to use the number of virtual cores your computer has, which is the output of `nproc` (which should be installed as part of `coreutils`). +**Note**: to speed up the build, you can pass `-jN` to `make setup` and `make`, where N is the number of threads to use in the build, e.g. `make -j4`. The generally-accepted wisdom is to use the number of virtual cores your computer has, which is the output of `nproc` (which should be installed as part of `coreutils`). The disadvantage that the ordering of the terminal output is scrambled, so for debugging it is best to stick to one thread (i.e. not pass `-jN`). (`-j` also exists, which uses unlimited jobs, but is generally slower.) |