Add README.md

.gitignore

@@ -1,39 +1,11 @@
-.vscode
+__pycache__/
-*.dat
-*.exe
-*.dll
-*.idb
-*.id0
-*.id1
-*.id2
-*.nam
-*.til
-*.o
-*.out
-*.elf
 *.dol
-*.a
-*.d
-*.map
-*.exe
 *.dump
-*.7z
+*.exe
-*.bat
+*.map
-*.sln
-*.filters
-*.vcxproj
-*.user
-include/*.s
-
 build/
-tools/mwcc_compiler/
+ctx.c
 tools/elf2dol
 tools/elf2rel
-decomp/
+tools/mwcc_compiler/*
-errors.txt
+!tools/mwcc_compiler/.gitkeep
-output.asm
-Debug/
-.vs/
-__pycache__/
-
-ctx.c

README.md

@@ -0,0 +1,60 @@
+Metroid Prime
+=============
+
+A decompilation of Metroid Prime (USA v0-00).
+
+This repository builds the following DOL:
+
+```
+949c5ed7368aef547e0b0db1c3678f466e2afbff  build/mp1.0/main.dol
+```
+
+Dependencies
+============
+
+Windows:
+--------
+- Install [devkitPro](https://github.com/devkitPro/installer/releases/latest) with GameCube development package.
+- Open `C:\devkitPro\msys2\msys2.exe`
+- Run the following:
+  ```
+  pacman -Sy --noconfirm --needed msys2-keyring
+  pacman -Su --noconfirm --needed gcc git gamecube-dev
+  ````
+
+macOS:
+------
+- Install wine:
+  ```
+  brew tap gcenx/wine
+  brew install wine-crossover
+  sudo xattr -r -d com.apple.quarantine "/Applications/Wine Crossover.app"
+  ```
+- Install [devkitPro](https://github.com/devkitPro/pacman/releases/latest).
+- Run the following:
+  ```
+  sudo dkp-pacman -Syu --noconfirm --needed gamecube-dev
+  ```
+
+Linux:
+------
+- Install wine from your package manager.
+- Install [devkitPro](https://devkitpro.org/wiki/devkitPro_pacman).
+- Run the following:
+  ```
+  sudo dkp-pacman -Syu --noconfirm --needed gamecube-dev
+  ```
+
+Building
+========
+
+- Checkout the repository:
+  ```
+  git clone https://github.com/PrimeDecomp/prime.git
+  ```
+- Download [GC_WII_COMPILERS.zip](https://cdn.discordapp.com/attachments/727918646525165659/917185027656286218/GC_WII_COMPILERS.zip)
+- Extract the contents of the `GC` directory to `tools/mwcc_compiler`
+- Build:
+  ```
+  make -j
+  ```