ref: b466020312c741eea6665b6588603f52919f5692
parent: 848efd5bac21e0c663204d56a3e8302078c2cc18
author: Lisandro Alarcón <aurealinbox@gmail.com>
date: Thu Jun 22 19:54:36 EDT 2023
Add macOS build info
--- a/README.md
+++ b/README.md
@@ -1,4 +1,8 @@
-# psx
+
+
+
+
+# psxe
A simple and portable Sony PlayStation emulator and emulation library written in C
## Screenshots
@@ -7,6 +11,8 @@
|  |  |
## Running
+You can head to the latest release and download the automated build for your platform. If your system isn't supported, you can easily build the emulator from source, instructions on "Building".
+
In order to run the emulator, you will need a BIOS file, `SCPH1001.bin` specifically, you can either get it from the internet or [dump it from your own console](https://www.youtube.com/watch?v=u8eHp0COcBo). Just put it in the same directory where the executable is located. I will write a CLI parser really soon though, you will be able to just specify the location of the BIOS or a search folder.
Other BIOSes aren't currently supported, though I've only tested `SCPH1000.bin` so far.
@@ -24,16 +30,23 @@
## Building
Building the emulator should be easy, just use the scripts provided in this repo.
-On Windows, the `build-deps.ps1` script downloads SDL2, unzips it, and copies `SDL2.dll` to the root folder, if you want to run the emulator standalone, you'll have to move the SDL2 DLL to the same folder where the executable is located.
+On Windows, the `build-deps.ps1` script downloads SDL2 and unzips it. If you want to run the emulator standalone, you'll have to move the SDL2 DLL to the same folder where the executable is located.
**If you already have SDL2 on your system**, you can skip running `build-deps.ps1`. Though you will have to edit `build-win.ps1` to point the `SDL2_DIR` variable to your installation path.
-On Ubuntu, you'll also need to install `libsdl2-dev`, you can get it from `apt` like so:
+On Ubuntu, you will also need to install `libsdl2-dev`, you can get it from `apt` like so:
```
sudo apt update
sudo apt upgrade
sudo apt install libsdl2-dev
```
+
+Building on macOS requires installing SDL2 and dylibbundler, this can be done using `brew`:
+```
+brew install sdl2
+brew install dylibbundler
+```
+
Assuming you did everything described above, you should be able to build the emulator running the following commands.
### Windows
@@ -50,4 +63,11 @@
git clone https://github.com/allkern/psx
cd psx
make clean && make
+```
+
+### macOS
+```
+git clone https://github.com/allkern/psx
+cd psx
+./build.sh
```
--
⑨