Skip to content

Commit e478062

Browse files
authored
Merge pull request #16 from allkern/master
Update README.md
2 parents 7e563c5 + 53326e6 commit e478062

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,49 +40,52 @@ Usage: iris [OPTION]... <path-to-disc-image>
4040
-v, --version Output version information and exit
4141
```
4242

43-
Launching a game or executable through the GUI is also very easy, just go to Iris > Open... and pick a disc image or ELF executable.
43+
Launching a game or executable through the GUI is also very easy, you can either go to Iris > Open... and pick a disc image or ELF executable, or just drop a file into Iris' window to launch it!
4444

4545
## Building
46-
Building the emulator should be pretty straightforward, just recursively clone the repository and follow the steps:
46+
> [!WARNING]
47+
> Building requires CMake on all supported platforms
4748
4849
### Linux
49-
Building for Linux targets requires SDL2, you may use `apt` on Debian-based distros to obtain it. You will also need a Python interpreter (and `python-is-python3`)
50+
Building on Linux requires installing SDL3 dependencies and FUSE if you wish to generate AppImages.
5051
```
5152
sudo apt update
5253
sudo apt upgrade
53-
sudo apt install libsdl2-dev python3 python-is-python3
54+
sudo add-apt-repository universe
55+
sudo apt-get install build-essential git make \
56+
pkg-config cmake ninja-build gnome-desktop-testing libasound2-dev libpulse-dev \
57+
libaudio-dev libjack-dev libsndio-dev libx11-dev libxext-dev \
58+
libxrandr-dev libxcursor-dev libxfixes-dev libxi-dev libxss-dev libxtst-dev \
59+
libxkbcommon-dev libdrm-dev libgbm-dev libgl1-mesa-dev libgles2-mesa-dev \
60+
libegl1-mesa-dev libdbus-1-dev libibus-1.0-dev libudev-dev libfuse2t64
5461
```
55-
56-
Then just run the following commands:
62+
Then just clone the repository and run CMake:
5763
```
5864
git clone https://github.com/allkern/iris --recursive
5965
cd iris
60-
./setup-gl3w.sh
61-
make -j8
66+
cmake -S . -B build
67+
cmake --build build -j8
6268
```
69+
Optionally run `cmake --install build` to generate an AppImage.
6370

6471
### Windows
65-
Our Windows build system currently targets GCC only, you can get a toolchain through MSYS2 or MinGW. You will additionally need to install a Python interpreter so `build-deps` can execute the gl3w download script.
66-
67-
Once that's done, just execute the following commands:
72+
We currently only support GCC as a compiler on Windows, this is because MSVC doesn't have an inline assembler, which we need to embed resources into the executable. This might eventually be fixed though!
6873
```
6974
git clone https://github.com/allkern/iris --recursive
7075
cd iris
71-
./build-deps.ps1
72-
./build-win.ps1
76+
cmake -S . -B build -G "MinGW Makefiles"
77+
cmake --build build -j8
7378
```
7479

7580
### macOS
76-
> [!WARNING]
77-
> Iris should support macOS but hasn't been fully tested yet
78-
79-
Building on macOS requires SDL2 and `dylibbundler`, you may install both using `brew` but keep in mind macOS builds aren't actively tested and may not work.
81+
Iris finally got working macOS builds!
8082
```
8183
git clone https://github.com/allkern/iris --recursive
8284
cd iris
83-
./setup-gl3w.sh
84-
./build.sh
85+
cmake -S . -B build
86+
cmake --build build -j8
8587
```
88+
Optionally run `sudo cmake --install build` to generate a macOS App Bundle
8689

8790
## Progress
8891
### Commercial games
@@ -137,5 +140,5 @@ This console is significantly more complex compared to the PS1, here's a rough l
137140
- 🟡 USB/FireWire?
138141
- 🔴 Ethernet
139142
- 🔴 PS1 backcompat (PS1 hardware)
140-
🟡 SIF
143+
🟢 SIF
141144
```

0 commit comments

Comments
 (0)