myx/README.md
2022-10-03 15:06:53 +03:00

49 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Библиотека дополнительных фукций для CMake
## Установка
В корневом каталоге проекта создать каталог `cmake/myx` и распаковать
в него архив проекта, который можно скачать [здесь](../../../releases).
## Использование
В основном файле `CMakeLists.txt` проекта после вызова команды
`project()` добавить строки:
```cmake
# Рекомендуемый способ подключения MyxCMake
include(cmake/myx_setup.cmake)
```
Создать файл `cmake/myx_setup.cmake`:
```cmake
#[=======================================================================[.rst:
Подключение дополнительных функций для CMake
По умолчанию предполагается использование версии MyxCMake,
файлы которой находятся в каталоге `cmake/myx` текущего проекта.
Для удобства разботки библиотеки MyxCMake можно указать путь
к её репозиторию с помощью переменной проекта CMake `MYX_CMAKE_DIR`
или переменной окружения `MYX_CMAKE_DIR`.
Если определена переменная `MYX_CMAKE_USE_SYSTEM`, то выполняется
поиск версии в каталогах перечисленных в переменной `CMAKE_MODULES_DIR`.
#]=======================================================================]
if(MYX_CMAKE_DIR)
set(ENV{MYX_CMAKE_DIR} ${MYX_CMAKE_DIR})
endif()
if(DEFINED ENV{MYX_CMAKE_DIR})
find_package(MyxCMake 1.99.65 REQUIRED)
else()
if(MYX_CMAKE_USE_SYSTEM)
find_package(MyxCMake 1.99.65 REQUIRED)
else()
include(${PROJECT_SOURCE_DIR}/cmake/myx/MyxCMakeConfig.cmake)
endif()
endif()
```