Stonks
ICT290 Assignment 1
Building • Contributing • License
Building
Tools
- macOS: brew
- Windows: vcpkg, Visual Studio 2019
Dependencies
- macOS:
brew install cmake sdl2 sdl2_image sdl2_ttf sdl2_mixer glm - Linux:
sudo apt-get install cmake libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-mixer-dev libglm-dev - Windows:
.\vcpkg.exe install --triplet x64-windows sdl2 sdl2-image sdl2-ttf sdl2-mixer glm
Cloning
git clone --recurse-submodules https://github.com/opeik/Stonk.git
git checkout develop && git submodule update --init
Building
- Unix:
cmake -S . -B build && cmake --build build && ./build/shays-world - Windows:
- Open Visual Studio as Administrator (required to make symbolic links)
- In Visual Studio, select Open → CMake, select
CMakeLists.txt - From the "Select Startup Item" menu, select
shays-world.exe
Contributing
- Ensure your editor uses Unix line endings
- Use the Line Endings Unifier plugin for Visual Studio
- Here's the suggested configuration
- Use clang-format to format your source code to the project standard
- Install a clang-format extension to your text editor:
License
This project is licensed under the ISC license. Please see the LICENSE.md file
for details.