aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorcrupest <crupest@outlook.com>2021-12-04 17:20:43 +0800
committercrupest <crupest@outlook.com>2021-12-04 17:20:43 +0800
commit2317061516b0bd0002467acbead3120cbe49a6c5 (patch)
treefb43dcc5067631d96ede6718c3fe0030678211f7 /README.md
parentff6cb3b468a0d4caf87c2291818d24e0a6d12b39 (diff)
downloadcru-2317061516b0bd0002467acbead3120cbe49a6c5.tar.gz
cru-2317061516b0bd0002467acbead3120cbe49a6c5.tar.bz2
cru-2317061516b0bd0002467acbead3120cbe49a6c5.zip
...
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 06f161e9..a6f20461 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,15 @@
## overview
-CruUI is a UI library.
+_cru_ is a UI library.
It is **under construction**. It can be built with _CMake_.
+After I changed to macOS, Windows feature is left behind now.
+
## build
-CruUI uses [_vcpkg_](https://github.com/microsoft/vcpkg) with _manifests mode_ to manage dependencies. You must setup vcpkg and `VCPKG_INSTALLATION_ROOT` environment variable.
+_cru_ uses [_vcpkg_](https://github.com/microsoft/vcpkg) with _manifests mode_ to manage dependencies. You must setup vcpkg and `VCPKG_INSTALLATION_ROOT` environment variable.
There is also a automatic python script used in CI. Use python3 to run `tool/win_build.py` to build on Windows. Run with `-h` to see options. For convenience to avoid environment setup it uses _Visual Studio_ generator.
@@ -38,8 +40,6 @@ Check the code or fire a issue if you have any problem.
- `snippets/` contains useful snippets file for _Visual Studio_, you can import it. **No longer use any more**, because now I develop CruUI in VS Code.
-- `drafts/` contains draft codes during refactor etc. They are not in main source but I think might be used in the future.
-
- `CMakeSettings.json` is a file that helps _Visual Studio_ to config CMake and setup intellisense.
## project structure