From f942094143314078b415876ceefcd1b41029f795 Mon Sep 17 00:00:00 2001 From: scawful Date: Thu, 8 Aug 2024 01:04:41 -0400 Subject: [PATCH] update build instructions, add iOS and GNU/Linux section --- docs/build-instructions.md | 49 ++++++++++++++++++++++++++++---------- 1 file changed, 36 insertions(+), 13 deletions(-) diff --git a/docs/build-instructions.md b/docs/build-instructions.md index d562c2fc..7fd38966 100644 --- a/docs/build-instructions.md +++ b/docs/build-instructions.md @@ -1,27 +1,50 @@ # Build Instructions -## Windows - -For VSCode users, use the following CMake extensions with MinGW-w64 +For VSCode users, use the following CMake extensions https://marketplace.visualstudio.com/items?itemName=twxs.cmake https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools -https://www.msys2.org/ +## Windows + +Recommended to use [msys2](https://www.msys2.org/) for a Unix-like environment on Windows. Add to environment variables `C:\msys64\mingw64\bin` Install the following packages using `pacman -S ` -`mingw-w64-x86_64-gcc` -`mingw-w64-x86_64-gcc-libs` -`mingw-w64-x86_64-cmake` -`mingw-w64-x86_64-glew` -`mingw-w64-x86_64-lib-png` +- `mingw-w64-x86_64-gcc` +- `mingw-w64-x86_64-gcc-libs` +- `mingw-w64-x86_64-cmake` +- `mingw-w64-x86_64-glew` +- `mingw-w64-x86_64-lib-png` + +For `yaze_py` you will need Boost Python + +- `mingw-w64-x86_64-boost` # macOS -- Clang 15.0.1 x86_64-apple-darrwin22.5.0 -- SDL2 Source v2.26.5 -- Removed snes_spc -- Removed asar_static \ No newline at end of file +Prefer to use clang over gcc. + +Install the following packages using `brew install ` + +- `cmake` +- `glew` +- `sdl2` +- `boost-python3` +- `libpng` + +# iOS + +Xcode is required to build for iOS. Currently testing with iOS 18 on iPad Pro. + +The xcodeproject file is located in the `ios` directory. + +You will need to link `SDL2.framework` and `libpng.a` to the project. + +# GNU/Linux + +You can use your package manager to install the same dependencies as macOS. + +I trust you know how to use your package manager. \ No newline at end of file