NepuShiro/libsm64
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Merge pull request #35 from Brawmario/feature/windows-test-build-instructions

Browse Source 
Update README with Windows test build instructions
This commit is contained in:
Jeremy Burns
2023-02-08 16:26:48 -07:00
committed by GitHub
parent 2166201d1b 3a22ea0761
commit 4583458108
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -2
View File
@@ -21,17 +21,20 @@ project under the `test` directory as well, demonstrating usage of the library.
## Building on Linux ## Building on Linux
- Ensure python3 is installed. - Ensure python3 is installed.
- Ensure the SDL2 and GLEW libraries are installed if you're building the test program (on Ubuntu: libsdl2-dev, libglew-dev) - Ensure the SDL2 and GLEW libraries are installed if you're building the test program (on Ubuntu: libsdl2-dev, libglew-dev).
- Run `make` to build. If you want to link musl libc instead of glibc run `LIBSM64_MUSL=1 make` instead. - Run `make` to build. If you want to link musl libc instead of glibc run `LIBSM64_MUSL=1 make` instead.
- To run the test program you'll need a SM64 US ROM in the root of the repository with the name `baserom.us.z64`. - To run the test program you'll need a SM64 US ROM in the root of the repository with the name `baserom.us.z64`.
## Building on Windows ## Building on Windows
- [Follow steps 1-4 for setting up MSYS2 MinGW 64 here](https://github.com/sm64-port/sm64-port#windows), but replace the repository URL with `https://github.com/libsm64/libsm64.git` - [Follow steps 1-4 for setting up MSYS2 MinGW 64 here](https://github.com/sm64-port/sm64-port#windows), but replace the repository URL with `https://github.com/libsm64/libsm64.git`
- Ensure the SDL2 and GLEW libraries are installed if you're building the test program.
- 64 bits: `pacman -S mingw-w64-x86_64-SDL2 mingw-w64-x86_64-glew`.
- 32 bits: `pacman -S mingw-w64-i686-SDL2 mingw-w64-i686-glew`.
- Run `make` to build - Run `make` to build
- To run the test program you'll need a SM64 US ROM in the root of the repository with the name `baserom.us.z64`.
## Make targets (all platforms) ## Make targets (all platforms)
- `make lib`: (Default) Build the `dist` directory, containing the shared object or DLL and public-facing header. - `make lib`: (Default) Build the `dist` directory, containing the shared object or DLL and public-facing header.
- `make test`: Builds the library `dist` directory as well as the test program. - `make test`: Builds the library `dist` directory as well as the test program.
- `make run`: Build and run the SDL+OpenGL test program. - `make run`: Build and run the SDL+OpenGL test program.