Merge pull request #36 from ahouts/master

Add Docker Support

README.md

@@ -16,6 +16,33 @@ A prior copy of the game is required to extract the required assets.
 
 ## Installation
 
+### Docker
+
+#### 1. Copy baserom(s) for asset extraction
+
+For each version (jp/us/eu) that you want to build a ROM for, put an existing ROM at
+`./baserom.<version>.z64` for asset extraction.
+
+#### 2. Create docker image
+
+```bash
+docker build -t sm64 .
+```
+
+#### 3. Build
+
+To build we simply have to mount our local filesystem into the docker container and build.
+
+```bash
+# for example if you have baserom.us.z64 in the project root
+docker run --rm --mount type=bind,source="$(pwd)",destination=/sm64 sm64 make VERSION=us -j4
+
+# if your host system is linux you need to tell docker what user should own the output files
+docker run --rm --mount type=bind,source="$(pwd)",destination=/sm64 --user $UID:$UID sm64 make VERSION=us -j4
+```
+
+Resulting artifacts can be found in the `build` directory.
+
 ### Linux
 
 #### 1. Copy baserom(s) for asset extraction