Installation

Getting Kontra TUI into your project is designed to be simple, modern, and efficient - just like the terminal UIs you'll build with it. You've got two ways to integrate it, depending on your preferences.

Method 1: The Modern Way with CPM.cmake (Recommended ✨)

This is the fastest and cleanest way to use Kontra - no cloning, no hassle. It fetches the library automatically during the CMake configuration step.

Prerequisites:

• A C++17 compatible compiler.
• CMake version 3.16 or higher.

Step 1: Download CPM.cmake

Download the latest CPM.cmake from CPM Github by following the steps given and place it in a cmake/ folder in your project.

Step 2: Add Kontra to your CMakeLists.txt

Step 3: Build

You're done! 🚀

📦 Method 2: The Classic Way with git submodule

Use this method if you prefer to track Kontra directly in your repository or want to work offline.

Prerequisites:

• git
• A C++17 compatible compiler
• CMake 3.16+

Step 1: Add Kontra as a Git Submodule

Resulting structure:

  YourCoolApp/
  ├── main.cpp
  ├── CMakeLists.txt
  └── external/
      └── kontra/

Step 2: Modify CMakeLists.txt

Step 3: Build

Still deciding?
🔰 Use CPM.cmake if you want ease of setup and automatic updates.
🔒 Use submodules if you want local control and version locking.

Either way, you're just a few lines away from building stylish terminal apps in C++. ✨