yyc12345
cc689ce8bb
- add MIT license - update README. remove WIP mark. - move some content from README to documentation.
17 lines
770 B
Markdown
17 lines
770 B
Markdown
# YYC Commonplace
|
|
|
|
YYC Commonplace, or YYCCommonplace (abbr. YYCC) is a static library specifically resolving my requirements in C++ and Windows scope.
|
|
|
|
## Usage
|
|
|
|
For more usage about this library, please build documentation of this project via Doxygen and read it.
|
|
|
|
And I also highly recommend that you read documentation first before writing with this library.
|
|
|
|
## Build
|
|
|
|
This project require at least CMake 3.23 to build. We suggest that you only use stable version (tagged commit). The latest commit may still work in progress and not stable.
|
|
|
|
For Windows builing, you can browse GitHub action script to have a preview. It actually is a simple calling to script file.
|
|
For other platforms building (e.g. Linux), you can following common builing way of CMake project.
|