Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ZgblKylin authored Mar 30, 2021
1 parent b8d7448 commit f0eeb7f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<KtUtils/global>` to your project. Feel free to use everything without manually include header files!

0 comments on commit f0eeb7f

Please sign in to comment.