User Guide
Quick Start

Quick Start

Get CPLib from Snapshot

CPLib is a library that consists only of header files. This means you don't have to worry about linking issues. The recommended way to use CPLib is to include the preprocessed single-header file. You can find the latest snapshot of the single-header file based on the main branch on GitHub (opens in a new tab).

Alternatively, you can download CPLib to a local folder using terminal commands.

Open the terminal and enter the following command:

curl -o cplib.hpp -L https://github.com/rindag-devs/cplib/raw/single-header-snapshot/cplib.hpp

This will download the latest snapshot of the single-header file based on the main branch and save it as cplib.hpp in the current directory.

Build from Source

In addition to using snapshots directly, building from source is another way to obtain a single file header.

Clone Git Repo

git clone https://github.com/rindag-devs/cplib.git --depth=1
cd cplib

Install PNPM dependencies

pnpm install

Build Single Header File

pnpm build-single-header

Get Output File

The final code is stored in out/single-header/cplib.hpp.

Start Learning

This document will explain how to use CPLib with examples. Additionally, whether you have prior experience using libraries like Testlib for development or not, it is recommended to start reading from the Checker chapter.