Add build instructions in README.md

This commit is contained in:
CocoSimone
2022-12-24 23:02:42 +01:00
parent 2fad0d8b98
commit eaf53a40ab

View File

@@ -7,6 +7,45 @@ Rewrite of my Nintendo 64 emulator "[shibumi](https://github.com/CocoSimone/shib
![Mario's face](resources/mario.png?raw=true)
## Build instructions:
First clone the repository: `git clone --recursive https://github.com/CocoSimone/Gadolinium`
### Windows
This build uses Visual Studio with Vcpkg and Clang-cl
Dependencies:
- CMake 3.20 or higher
- SDL2 (install it by making sure that you're choosing the "vulkan" extension of the package and the x64-windows triplet: `vcpkg install sdl2[vulkan]:x64-windows`)
- fmtlib (install it by making sure that you're choosing the x64-windows triplet: `vcpkg install fmt:x64-windows`)
- nlohmann-json (install it by making sure that you're choosing the x64-windows triplet: `vcpkg install nlohmann-json:x64-windows`)
```
cd path/to/gadolinium
mkdir build
cd build
cmake -T clangcl -DCMAKE_TOOLCHAIN_FILE=path/to/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=Release -S ../src
cmake --build . --config Release
```
### Linux
Dependencies:
- GCC or Clang with C++17 support
- CMake 3.20 or higher
- SDL2
- fmtlib
- Vulkan API (including the validation layers) + SPIR-V tools
- nlohmann-json
```
cd path/to/gadolinium
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -S ../src
cmake --build . --config Release
```
Special thanks:
- [Dillonb](https://github.com/Dillonb) and [KieronJ](https://github.com/KieronJ) for bearing with me and my recurring brainfarts, and for the support :heart: