summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMisterSheeple <27652712+MisterSheeple@users.noreply.github.com>2023-11-08 00:36:48 -0500
committerGitHub <noreply@github.com>2023-11-07 22:36:48 -0700
commit8b3577c21449d31d31381e8e9c3e64407a5fb6c9 (patch)
tree9d7d8fa3a643225a577907f8ffe0fd0163c6eff4 /README.md
parent12942741429715a5649cf5f24f291ff478e68cae (diff)
Upgrade Dockerfile to Ubuntu 22.04 as 18.04 is EOL (#491)
* Upgrade Dockerfile to Ubuntu 22.04 as 18.04 is EOL * Update dependencies to use current ones * Remove extra package that I don't think is required * Remove use of old qemu irix * Update and rename Dockerfile-ci to Dockerfile * Add docker instructions to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index e0ae47f97..94b3aad64 100644
--- a/README.md
+++ b/README.md
@@ -89,6 +89,24 @@ brew install python3 capstone coreutils make pkg-config tehzz/n64-dev/mips64-elf
When building, use `gmake` to ensure that homebrew `make` is used instead of the old, macOS system `make`.
+#### Docker
+
+Build the Docker image:
+```
+docker build -t mk64 .
+```
+
+When building and using other tools, append the following in front of every command you run:
+```bash
+docker run --rm -v ${PWD}:/mk64 mk64
+```
+
+For example:
+```bash
+docker run --rm -v ${PWD}:/mk64 mk64 make -C tools
+docker run --rm -v ${PWD}:/mk64 mk64 make
+```
+
## Building
Place a US version of Mario Kart 64 called `baserom.us.z64` into the project folder for asset extraction.