diff --git a/README.md b/README.md index 0d811ae..98f5373 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,25 @@ [![Codacy Badge](https://app.codacy.com/project/badge/Grade/a70beb37999b4a6298de4e4d3b3510d8)](https://www.codacy.com/gh/ZgblKylin/KtUtils/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ZgblKylin/KtUtils&utm_campaign=Badge_Grade) Qt Utilities by ZgblKylin. + +## Build + +This project is designed to be integrate as a sub_directory. + +### Configure + +Two CMake built-in options are used: + +- `BUILD_SHARED_LIBS`: `OFF` by default, enable to build shared libraries. +- `BUILD_TESTING`: `OFF` by default, enable to build tests. + +### Compile + +Just add these codes into your `CMakeLists.txt` + +```cmake +add_subdirectory(KtUtils) +target_link_library(${PROJECT_NAME} PUBLIC KtUtils) +``` + +Then it'll export precompile header `` to your project. Feel free to use everything without manually include header files!