diff --git a/README.md b/README.md index 7cd780b11..5091a09d5 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,20 @@ The build system has the following package requirements: qemu-irix Debian / Ubuntu - +``` sudo apt install build-essential pkg-config git binutils-mips-linux-gnu python3 zlib1g-dev libaudiofile-dev +``` Download latest package from qemu-irix Releases -sudo dpkg -i qemu-irix-2.11.0-2169-g32ab296eef_amd64.deb +`sudo dpkg -i qemu-irix-2.11.0-2169-g32ab296eef_amd64.deb` (Optional) Clone https://github.com/n64decomp/qemu-irix and follow the install instructions in the README. ## Building +Place a US version of Mario Kart 64 called `baserom..z64` into the project folder for asset extraction. + Run the following commands after pulling: * make -C tools @@ -36,4 +39,9 @@ Run the following commands after pulling: ## Contributing + Pull requests are welcome. + +Run `clang-format` on your code to ensure it meets the project's coding standards. + +Official Discord: [discord.gg/DuYH3Fh](https://discord.gg/DuYH3Fh)