aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorcrupest <crupest@outlook.com>2019-05-24 23:58:38 +0800
committercrupest <crupest@outlook.com>2019-05-24 23:58:38 +0800
commita191a44e0ec7fd353cb9a60e2e7a18f45f6df04a (patch)
treee07c739ac86c48f47829694960a2f0319037227d /README.md
parent62400fbb5a795bd490a313443401a1012e7917c2 (diff)
downloadcru-a191a44e0ec7fd353cb9a60e2e7a18f45f6df04a.tar.gz
cru-a191a44e0ec7fd353cb9a60e2e7a18f45f6df04a.tar.bz2
cru-a191a44e0ec7fd353cb9a60e2e7a18f45f6df04a.zip
Update readme.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9ffd8497..8b7ed3f5 100644
--- a/README.md
+++ b/README.md
@@ -6,11 +6,11 @@
CruUI is a UI library.
-It is **under construction**.
+It is **under construction**. It can be built with *CMake*.
## build
-Use python3 to run `tool/build.py`. Run with `-h` to see the options.
+Use python3 to run `tool/win_build.py` to build on Windows. Run with `-h` to see the options.
## structure of repository
@@ -26,6 +26,9 @@ Use python3 to run `tool/build.py`. Run with `-h` to see the options.
- `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)