yyc12345/YYCCommonplace
1
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: update build script and documentation.

Browse Source 
- update build script.
- update documentation about build script changes.
This commit is contained in:
yyc12345
2024-08-14 17:26:38 +08:00
parent dc98486fff
commit 59c185a424
7 changed files with 36 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -8,9 +8,10 @@ For more usage about this library, please build documentation of this project vi
And I also highly recommend that you read documentation first before writing with this library.
However, the documentation need CMake to build and you may don't know how to use CMake in this project. So as the alternative, you also can browse the raw Doxygen documentation file: `doc/src/intro.dox` for how to build this project (including documentation) first.
## 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.
See documentation for how to build this project.