1<!--
2     Copyright 2018, Data61
3     Commonwealth Scientific and Industrial Research Organisation (CSIRO)
4     ABN 41 687 119 230.
5
6     This software may be distributed and modified according to the terms of
7     the BSD 2-Clause license. Note that NO WARRANTY is provided.
8     See "LICENSE_BSD2.txt" for details.
9
10     @TAG(DATA61_BSD)
11-->
12Global Components
13=================
14
15This repository contains a collection of reusable CAmkES components and 
16interfaces.
17
18cmake
19-----
20
21To include components and interfaces from this repository ensure that
22`global-components.cmake` is included in your project.  An example is below.
23
24```cmake
25find_file(GLOBAL_COMPONENTS_PATH global-components.cmake PATHS ${CMAKE_SOURCE_DIR}/projects/global-components/ CMAKE_FIND_ROOT_PATH_BOTH)
26mark_as_advanced(FORCE GLOBAL_COMPONENTS_PATH)
27if("${GLOBAL_COMPONENTS_PATH}" STREQUAL "GLOBAL_COMPONENTS_PATH-NOTFOUND")
28    message(FATAL_ERROR "Failed to find global-components.cmake. Consider cmake -DGLOBAL_COMPONENTS_PATH=/path/to/global-components.cmake")
29endif()
30include(${GLOBAL_COMPONENTS_PATH})
31```
32