aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 8b7ed3f5f3e74cc5b5df02327f8338edb76a8e15 (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
32
33
34
# CruUI

[![Build Status](https://dev.azure.com/crupest/CruUI/_apis/build/status/crupest.CruUI)](https://dev.azure.com/crupest/CruUI/_build/latest?definitionId=5)

## overview

CruUI is a UI library.

It is **under construction**. It can be built with *CMake*.

## build

Use python3 to run `tool/win_build.py` to build on Windows. Run with `-h` to see the options.

## structure of repository

- `include/` contains public headers.

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

- `tools/` contains some codes of tools like code generators.

  - `tools/cppmerge` contains a *python* script program that merges all cpp headers and sources into one **single** header and source. **Not use now**.

  - `tools/build.py` is a python3 script to build the source code.

- `snippets/` contains useful snippets file for *Visual Studio*, you can import it.

- `CMakeSettings.json` is a file that helps *Visual Studio* to config CMake and setup intellisense.

## project structure
Test and Linux module is not developed now.

![project structure](art/project_structure.png)