diff options
| author | Parker Burnett <jpburnett@gwu.edu> | 2022-07-11 20:54:17 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-11 23:54:17 -0400 |
| commit | 66c4d743b32b56820c2dc5c2e057caa418e06b4b (patch) | |
| tree | 518229e919d9cb5bf95c4e60a7cf9e989f6fc6ef /README.md | |
| parent | 87506f7c1979c4dea1e1a99e3d7ba80f5ec289f0 (diff) | |
Adding Docker Support (#914)
* Adding dockerfile and instructions for building
* fixing readme and updating Dockerfile
* Adding packages and practicerom support
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 8 insertions, 4 deletions
@@ -28,15 +28,16 @@ This is a WIP **decompilation** of ***The Legend of Zelda: Majora's Mask***. The The only version currently supported is N64 US, but we intend to eventually support every retail version of the original game (i.e. not versions of MM3D, which is a totally different game). It currently builds the following ROM: + * mm.us.rev1.rom.z64 `md5: 2a0a8acb61538235bc1094d297fb6556` **This repo does not include any assets or assembly code necessary for compiling the ROM. A prior copy of the game is required to extract the required assets.** Please refer to the following for more information: -* [Website](https://zelda64.dev/) -* [Discord](https://discord.zelda64.dev/) -* [How to Contribute](docs/CONTRIBUTING.md) +- [Website](https://zelda64.dev/) +- [Discord](https://discord.zelda64.dev/) +- [How to Contribute](CONTRIBUTING.md) ## Installation @@ -50,6 +51,10 @@ We recommend using Debian or Ubuntu 20.04 Linux distributions. Preparation is covered in a [separate document](docs/BUILDING_MACOS.md). +### Docker + +Preparation is covered in [Building Docker](docs/BUILDING_DOCKER.md). + ### Linux (Native or under WSL / VM) #### 1. Install build dependencies @@ -130,7 +135,6 @@ Running `make init` will also make the `./expected` directory and copy all of th 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.) - ## Contributing All contributions are welcome. This is a group effort, and even small contributions can make a difference. |
