Skip to content

Commit

Permalink
docs: Update README.md and don't treat plugins as standalone
Browse files Browse the repository at this point in the history
  • Loading branch information
zchrissirhcz committed Nov 23, 2024
1 parent a813c43 commit 62a1589
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 20 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# RocBuild

<img alt="GitHub" src="https://img.shields.io/github/license/zchrissirhcz/RocBuild"> ![Ubuntu](https://img.shields.io/badge/Ubuntu-333333?style=flat&logo=ubuntu) ![Windows](https://img.shields.io/badge/Windows-333333?style=flat&logo=windows&logoColor=blue) ![macOS](https://img.shields.io/badge/-macOS-333333?style=flat&logo=apple) ![android](https://img.shields.io/badge/-Android-333333?style=flat&logo=Android) ![Build Status](https://github.com/zchrissirhcz/rocbuild/actions/workflows/build.yml/badge.svg)

A set of cmake plugins for C/C++ building.
![Build Status](https://github.com/zchrissirhcz/rocbuild/actions/workflows/build.yml/badge.svg)

## rocsetup.cmake

Ease your cmake configure setup. e.g.
[rocsetup.cmake](rocsetup.cmake) is a starter program for CMake configure step.

Usage:
```pwsh
cmake -P rocsetup.cmake -p vs2022 -a x64
```
Expand All @@ -19,7 +18,18 @@ cmake -S . -B build -G "Visual Studio 17 2022" -A x64

## rocbuild.cmake

Ease your cmake build experience, by add one line in your `CMakeLists.txt`:
[rocbuild.cmake](rocbuild.cmake) is a set of functions/macros for daily building opeorations:
- copy dlls for recursive shared dependencies
- copy OpenCV's videoio dlls
- enable Ninja colorful output by default
- use `CMAKE_BINARY_DIR` as output location for artifacts: `.a/.lib/.dll/.so/.exe/...`
- more fuctionalities to be added...

Usage: add one line in your `CMakeLists.txt`:
```cmake
include(rocbuild.cmake)
```

## plugins

[plugins directory](plugins/README.md) provides a collection of standalone cmake plugins.
15 changes: 0 additions & 15 deletions rocbuild.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -47,21 +47,6 @@ macro(rocbuild_enable_ninja_colorful_output)
endmacro()


macro(rocbuild_enable_sanitizer_options)
if(ASAN)
include(plugins/asan.cmake)
endif()

if(HWASAN)
include(plugins/hwasan.cmake)
endif()

if(TSAN)
include(plugins/tsan.cmake)
endif()
endmacro()


function(rocbuild_copy_dll target)
add_custom_command(TARGET ${target} POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_RUNTIME_DLLS:${target}> $<TARGET_FILE_DIR:${target}>
Expand Down

0 comments on commit 62a1589

Please sign in to comment.