Skip to content
This repository has been archived by the owner on Dec 23, 2022. It is now read-only.

Latest commit

 

History

History
61 lines (48 loc) · 2.71 KB

README.md

File metadata and controls

61 lines (48 loc) · 2.71 KB
Raw

Platformer Engine

CPP Clang Tidy Linter Build Doxygen CodeCov

Getting Started

  • Install VCPKG
  • Clone the repository
  • Follow MacOS instructions if you are on MacOS, if you are on Windows follow the Windows instructions, otherwise continue
  • Run git submodule update --init --recursive
  • Run vcpkg integrate install
  • Add the following CMake options:
    • -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
    • -DVCPKG_TARGET_TRIPLET=[x64-windows | x64-osx | arm64-osx | x64-linux | x64-mingw-static ] (depending on your platform and compiler)
      • When using CLion, go to File (Preferences on MacOS) > Settings > Build, Execution, Deployment > CMake > CMake Options and add the options there
      • Be sure to check which toolchain is being used, if MinGW is used, use the [x64|arm64]-mingw-static triplet

MacOS

  • Install Brew
  • Install CMake: brew install cmake
  • Install GCC: brew install gcc
  • Install VCPKG to the terminal:
    • ./vcpkg integrate bash
    • ./vcpkg integrate zsh
  • Continue with the instructions above

Windows

  • Add the VCPKG directory to your PATH environment variable
  • Continue with the instructions above

Contributing

  • Create a new branch
  • Make your changes
  • Update the CHANGELOG.md file
  • Create a pull request and assign it to two team members. The GitHub Actions must succeed and both team members must approve the pull request before it can be merged.

Making a pull request

  • Make sure you have updated the CHANGELOG.md file
  • Make sure you have added the Jira ticket number to the title
  • Fill out the pull request template
  • Assign two team members to review your pull request
  • The GitHub Actions must succeed and both team members must approve the pull request before it can be merged.

Documentation