Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.17 KB

README.md

File metadata and controls

66 lines (43 loc) · 2.17 KB
Raw

CMakeTemplate

Repo Size License

A flexible, extensible and cross-platform CMake Template to compile small and large C and C++ Projects

ℹ️ Usage

🧱 Setup

Create a new repository from the Template on Github:
git clone https://github.com/TheMagehawk/CMakeTemplate.git

⚙️ Configuration

Now you can write custom source files in the src directory. Source files need to be added in the CMakeLists.txt:

list(APPEND SOURCE_FILES ...)

External dependencies can be added as Git submodules or Local Copies into the external directory. The target name for each dependency needs to be addressed in the CMakeLists.txt:

list(APPEND LIBS ...)

Additional flags or variables can be set directly in the Root CMakeLists.txt!

🔄 Continuous integration

This Template is provided with Github Workflow Jobs to automate compilation.
To enable the jobs remove if: False or replace it with if: True for each desired job.

🛠️ Build

🆚 Visual Studio

  • Initialize and update all submodules in this project (including external modules/dependencies):
    git submodule update --init --recursive --depth=1
  • Configure the CMake Project (and delete and regenerate Cache if needed or error)
  • Run one of the available Configurations

🖨️ Command Line

🐧 Linux:

  • Run chmod +x build.sh && ./build.sh [FLAGS]

🖼️ Windows:

  • Run ./build.bat [FLAGS]

🍎 MacOS:

  • Run chmod +x build.sh && ./build.sh [FLAGS]

🤖 Android (Experimental right now):

  • Cross Compile on Windows:
    ./build.bat --android [NDK_PATH]
  • Cross Compile on Linux:
    ./build.sh --android [NDK_PATH]

🍏 iOS:

  • Maybe someday...

🚩 Configuration/Build Flags

./build.sh --help or ./build.bat --help as flags to print out all available build flags