diff options
| author | crupest <crupest@outlook.com> | 2018-11-13 23:09:36 +0800 |
|---|---|---|
| committer | crupest <crupest@outlook.com> | 2018-11-13 23:09:36 +0800 |
| commit | 77f9d6d47660b642c991809387e4e5c114760f84 (patch) | |
| tree | 71e75641af600b762dabdba420d8be094b523c64 | |
| parent | b08ba6c83902d140fb14131b3f01837985d39c17 (diff) | |
| download | cru-77f9d6d47660b642c991809387e4e5c114760f84.tar.gz cru-77f9d6d47660b642c991809387e4e5c114760f84.tar.bz2 cru-77f9d6d47660b642c991809387e4e5c114760f84.zip | |
Update readme.
| -rw-r--r-- | README.md | 25 |
1 files changed, 24 insertions, 1 deletions
@@ -2,8 +2,31 @@ [](https://dev.azure.com/crupest/CruUI/_build/latest?definitionId=5) -CruUI is a UI library running on **Windows** platform using Direct2D hardware accelaration. +## overview + +CruUI is a UI library running on *Windows* platform using *Direct2D* hardware accelaration. It is **under construction**. Please using VS2017 open the `CruUI.sln` file in the root directory. + +## structure of repository + +- `CruUI.sln` is *Visual Studio* solution file of the repository which including two vc++ projects. + + - `CruUI.vcxproj` is a *Visual Studio* vc++ project file that includes the main code in `src/`. + + - `CruUI-Generate/CruUI-Generate.vcxproj` is a *Visual Studio* vc++ project file that includes a header and a source generated from tools(see below). It is a project used to test that generated codes work well. + +- `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. + +- `scripts/` contains some useful scripts. + + - `scripts/merge.py` is a *python* script that invoke the *cppmerge* tool to merge code in `src\` to `CruUI-Generate\cru_ui.h` and `CruUI-Generate\cru_ui.cpp`. + +- `CruUI-Generate/` contains codes and project file that used to test merged codes. + |