aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a59e81528ae9c18a81826e0cf517e3ed0ae32fb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# CruUI

[![CI](https://github.com/crupest/cru/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/crupest/cru/actions/workflows/ci.yml)

## overview

_cru_ is a C++ library. The biggest part of it is for UI.

It is **under heavy construction**.

Check the code or file a issue if you have any problem.

## build

_cru_ is built with [_CMake_](https://cmake.org/).

## structure of repository

- `include/` contains public headers.

- `src/` contains the main codes, including private headers and sources.

- `test/` contains unit tests.

- `demos/` contains sources of demos. They are also used for integrated tests.

- `lib/` 3rd party libraries.

- `scripts/` contains helper scripts and tools used for development.

- `assets/` contains non-source codes.