Skip to main content

Quick Start

This page will guide you through setting up Quick-FTXUI's repository & running the examples

1. Clone the Repository

First, clone the repository in your system

  git clone https://github.com/vrnimje/quick-ftxui.git
cd quick-ftxui

2. Build

Then, in the directory, create a build folder and build the project, with examples, using CMake

  mkdir build
cd build
cmake .. -GNinja -DQUICK_FTXUI_FETCH_BOOST=On -DQUICK_FTXUI_EXAMPLES=On

3. Run Examples

To run the examples, execute the following command, for C++ examples

  ./examples/quick_ftxui_example

For QF examples (.qf files), execute the following command

  ./quick-ftxui ../examples/[file_name].qf

Further reading

Read the docs for understanding the Quick-FTXUI language