Skip to content

Commit f3cfa4b

Browse files
committed
Update README and fix CI build path
1 parent ef87ed5 commit f3cfa4b

2 files changed

Lines changed: 31 additions & 2 deletions

File tree

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
mkdir release_package
2626
mkdir release_package\src
2727
mkdir release_package\src\rom
28-
copy build\gb_emulator.exe release_package\
28+
copy build\Release\gb_emulator.exe release_package\
2929
echo. > release_package\settings.ini
3030
echo. > release_package\src\rom\.gitkeep
3131
shell: cmd

‎README.md‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,33 @@ A complete GameBoy emulator written in C++ with SDL2, OpenGL, and ImGui.
1313
- ImGui user interface, allowing drag-and-drop of ROM files directly into the window to play immediately
1414
- Slow-motion support
1515

16+
## Build & Run Instructions
17+
This emulator is built specifically for **Windows 11**.
18+
19+
### Requirements
20+
- **OS**: Windows 11
21+
- **CMake**: Version 3.20 or higher
22+
- **Compiler**: MSVC (Visual Studio 2019/2022) or any compatible C++20 compiler on Windows.
23+
24+
### Build from source
25+
Open your terminal (Command Prompt / PowerShell) and run the following commands:
26+
```bat
27+
# 1. Generate the build files
28+
cmake -B build
29+
30+
# 2. Compile the executable
31+
cmake --build build --config Release
32+
```
33+
The compiled executable will be located at `build/Release/gb_emulator.exe`.
34+
35+
### Running the Emulator
36+
You can launch the emulator in two ways:
37+
1. **Direct Launch**: Simply double-click `gb_emulator.exe`. Once the window opens, you can drag and drop any `.gb` ROM file into the emulator window to start playing.
38+
2. **Command Line**: Run the executable and pass the ROM file path as an argument.
39+
```bat
40+
gb_emulator.exe "path/to/your/game.gb"
41+
```
42+
1643
## ROMs
1744
You can download test ROMs and game ROMs to play from the links below:
1845
- **Test ROMs:** [c-sp/game-boy-test-roms](https://github.com/c-sp/game-boy-test-roms)
@@ -25,5 +52,7 @@ You can download test ROMs and game ROMs to play from the links below:
2552
- **Dear ImGui** (UI & Layout)
2653

2754
## Contact Info
28-
- **Created by**: shinnei1509
55+
- **Created by**: Nguyen Huu Huy Thinh (shinnei1509)
56+
- **Email**: dst15092004@gmail.com
57+
- **Website**: [https://shinnei.github.io/](https://shinnei.github.io/)
2958
- **GitHub**: [shInNei](https://github.com/shInNei)

0 commit comments

Comments
 (0)