diff options
| author | Yuqian Yang <crupest@crupest.life> | 2026-03-07 21:49:37 +0800 |
|---|---|---|
| committer | Yuqian Yang <crupest@crupest.life> | 2026-03-07 21:49:37 +0800 |
| commit | fcd03ecc3d3d2635ffa09f7edb4216950b6f3caf (patch) | |
| tree | 3c275bc0a115db47e168c9e29b36fbb53dcb52fe /README.md | |
| parent | 38756822825e20eca3b9e01b735946175223d692 (diff) | |
| download | cru-fcd03ecc3d3d2635ffa09f7edb4216950b6f3caf.tar.gz cru-fcd03ecc3d3d2635ffa09f7edb4216950b6f3caf.tar.bz2 cru-fcd03ecc3d3d2635ffa09f7edb4216950b6f3caf.zip | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 8 insertions, 6 deletions
@@ -8,7 +8,7 @@ _cru_ is a C++ library. The biggest part of it is for UI. It is **under heavy construction**. -Check the code or fire a issue if you have any problem. +Check the code or file a issue if you have any problem. ## build @@ -18,12 +18,14 @@ _cru_ is built with [_CMake_](https://cmake.org/). - `include/` contains public headers. -- `src/` contains the main codes including headers and sources. +- `src/` contains the main codes, including private headers and sources. -- `test/` contains unit tests. Only targets in this directories need `gtest`. +- `test/` contains unit tests. -- `demo/` contains sources of demo excutable targets. They are mostly used for integrated tests but can also be used for demonstration. +- `demos/` contains sources of demos. They are also used for integrated tests. -- `lib/` other libraries being used. +- `lib/` 3rd party libraries. -- `tools/` contains some codes of tools I wrote for development. However most of them are not used now. +- `scripts/` contains helper scripts and tools used for development. + +- `assets/` contains non-source codes. |