ref: 540167a714a5f8f9c9335818801187baad91f1bc
parent: ece639e2f9dfb52f9f63423f7ce6dc224c176dbc
author: VictorXPDE <[email protected]>
date: Wed Oct 12 18:51:36 EDT 2022
Improve README.md (#146)
--- a/README.md
+++ b/README.md
@@ -43,33 +43,53 @@
## Installing Python & libraries on Windows (required for asset extraction steps)
1. Download [Python](https://www.python.org/ftp/python/3.10.7/python-3.10.7-amd64.exe) installer and install
2. Open the command prompt
-3. Type "python -m pip install --upgrade pip" and hit enter
-4. Type "python -m pip install --upgrade Pillow" and hit enter
-5. Type "python -m pip install --upgrade pyyaml" and hit enter
-6. Close the command prompt
+3. Upgrade pip & install `pillow` and `pyyaml` by typing `python -m pip install --upgrade pip pillow pyyaml` and hit enter
+4. Close the command prompt
## Compiling on Windows with TCC (1mb Tiny C Compiler)
1. Download the project by clicking "Code > Download ZIP" on the github page
2. Extract the ZIP to your hard drive
-3. Place the USA rom named "zelda3.sfc" in the "\tables" subfolder
+3. Place the USA rom named `zelda3.sfc` in the "\tables" subfolder
4. Open the command prompt and navigate to that folder
-5. Type "python extract_resources.py" and hit enter
-6. Type "python compile_resources.py" and hit enter
+5. Extract resources by typing `python extract_resources.py` and hit enter
+6. Compile the extracted resources by typing `python compile_resources.py` and hit enter
7. Close the command prompt
8. Download [TCC](https://download.savannah.gnu.org/releases/tinycc/tcc-0.9.27-win64-bin.zip) and extract to the "\third_party" subfolder
9. Download [SDL2](https://github.com/libsdl-org/SDL/releases/download/release-2.24.0/SDL2-devel-2.24.0-VC.zip) and extract to the "\third_party" subfolder
-10. Double-click "run_with_tcc.bat" in the main dir to create zelda3.exe in that same dir
-11. Configure with zelda3.ini in the main dir
+10. Double-click `run_with_tcc.bat` in the main dir to create `zelda3.exe` in that same dir
+11. Configure with `zelda3.ini` in the main dir
## Compiling on Windows with Visual Studio (4.5gb IDE and compiler)
Same Steps 1-7 above<br/>
-8. Double-click "Zelda3.sln"<br/>
+8. Double-click `Zelda3.sln`<br/>
9. Change "debug" to "release" in the top dropdown<br/>
-10. Choose "build > build Zelda3" in the menu to create zelda3.exe in the "/bin/release" subfolder<br/>
-11. Configure with zelda3.ini in the main dir<br/>
+10. Choose "build > build Zelda3" in the menu to create `zelda3.exe` in the "/bin/release" subfolder<br/>
+11. Configure with `zelda3.ini` in the main dir<br/>
-## Compiling on Linux/MacOS
+## Installing libraries on Linux/MacOS
+1. Open a terminal
+2. Install pip if not already installed
+```sh
+python3 -m ensurepip
+```
+3. Clone the repo and `cd` into it
+```sh
+git clone https://github.com/snesrev/zelda3
+cd zelda3
+```
+4. Install requirements using pip
+```sh
+python3 -m pip install -r requirements.txt
+```
+5. Install SDL2
+* Ubuntu/Debian `sudo apt install libsdl2-dev`
+* Fedora Linux `sudo dnf in sdl2-devel`
+* Arch Linux `sudo pacman -S sdl2`
+* macOS: `brew install sdl2` (you can get homebrew [here](https://brew.sh/))
+## Compiling on Linux/MacOS
+1. Place your US ROM file named `zelda3.sfc` in `zelda3/tables`
+2. Compile
```sh
make
```
@@ -100,6 +120,9 @@
## More Compilation Help
Look at the wiki at https://github.com/snesrev/zelda3/wiki for more help.
+
+The ROM needs to be named `zelda3.sfc` and has to be from the US region with this exact SHA256 hash
+`66871d66be19ad2c34c927d6b14cd8eb6fc3181965b6e517cb361f7316009cfb`
In case you're planning to move the executable to a different location, please include the file `tables/zelda3_assets.dat`.