Integration instructions.

This commit is contained in:
redcode
2022-06-28 22:18:37 +02:00
parent 833b62be97
commit 2a7246b29b
3 changed files with 14 additions and 16 deletions

18
README
View File

@@ -217,22 +217,20 @@ install the package:
4.1. As an external dependency in CMake-based projects
The Z80 library includes a config-file package for integration into CMake-based
projects, which should be installed on development environments. As usual, just
call "find_package" to find the library. This creates the imported "Z80" target
carrying the necessary transitive link dependencies. The linking method can
optionally be selected by specifying the "Shared" or "Static" component of the
Z80 package.
projects, which should be installed for development. Use "find_package" to find
the "Z80" package. This creates the "Z80" imported library target that carries
the necessary transitive link dependencies. The linking method can optionally be
selected by specifying the "Shared" or the "Static" component.
Example:
find_package(Z80 REQUIRED [Shared|Static])
find_package(Z80 REQUIRED Shared)
target_link_libraries(your-target Z80)
When not specified as a component, the linking method is selected according to
"Z80_SHARED_LIBS". If this option is not defined, the config-file package uses
the type of library that is installed on the system and, if it finds both the
shared and the static versions, "BUILD_SHARED_LIBS" determines which one to link
against.
"Z80_SHARED_LIBS". If this option is not defined, the config-file uses the type
of library that is installed on the system and, if it finds both the shared and
the static versions, "BUILD_SHARED_LIBS" determines which one to link against.
4.2. As a CMake subproject

View File

@@ -400,16 +400,16 @@ The CRC errors in the latter two are normal and match the values obtained on rea
### As an external dependency in CMake-based projects
The Z80 library [includes](#option_z80_with_cmake_support) a [config-file package](https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#config-file-packages) for integration into CMake-based projects, which should be installed on development environments. As usual, just call [`find_package`](https://cmake.org/cmake/help/latest/command/find_package.html) to find the library. This creates the imported `Z80` target carrying the necessary transitive link dependencies. The linking method can optionally be selected by specifying the `Shared` or `Static` component of the `Z80` package.
The Z80 library [includes](#option_z80_with_cmake_support) a [config-file package](https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#config-file-packages) for integration into CMake-based projects, which should be installed for development. Use [`find_package`](https://cmake.org/cmake/help/latest/command/find_package.html) to find the `Z80` package. This creates the `Z80` imported library target that carries the necessary transitive link dependencies. The linking method can optionally be selected by specifying the `Shared` or the `Static` component.
Example:
```cmake
find_package(Z80 REQUIRED [Shared|Static])
find_package(Z80 REQUIRED Shared)
target_link_libraries(your-target Z80)
```
When not specified as a component, the linking method is selected according to [`Z80_SHARED_LIBS`](#option_z80_shared_libs). If this option is not defined, the config-file package uses the type of library that is installed on the system and, if it finds both the shared and the static versions, [`BUILD_SHARED_LIBS`](https://cmake.org/cmake/help/latest/variable/BUILD_SHARED_LIBS.html) determines which one to link against.
When not specified as a component, the linking method is selected according to [`Z80_SHARED_LIBS`](#option_z80_shared_libs). If this option is not defined, the config-file uses the type of library that is installed on the system and, if it finds both the shared and the static versions, [`BUILD_SHARED_LIBS`](https://cmake.org/cmake/help/latest/variable/BUILD_SHARED_LIBS.html) determines which one to link against.
### As a CMake subproject

View File

@@ -17,16 +17,16 @@ Integration
As an external dependency in CMake-based projects
-------------------------------------------------
The Z80 library includes a `config-file package <https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#config-file-packages>`_ for integration into CMake-based projects, which should be installed on development environments. As usual, just call ``find_package`` to find the library. This creates the imported ``Z80`` target carrying the necessary transitive link dependencies. The linking method can optionally be selected by specifying the ``Shared`` or ``Static`` component of the ``Z80`` package.
The Z80 library includes a `config-file package <https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#config-file-packages>`_ for integration into CMake-based projects, which should be installed for development. Use ``find_package`` to find the ``Z80`` package. This creates the ``Z80`` imported library target that carries the necessary transitive link dependencies. The linking method can optionally be selected by specifying the ``Shared`` or the ``Static`` component.
Example:
.. code-block:: cmake
find_package(Z80 REQUIRED [Shared|Static])
find_package(Z80 REQUIRED Shared)
target_link_libraries(your-target Z80)
When not specified as a component, the linking method is selected according to ``Z80_SHARED_LIBS``. If this option is not defined, the config-file package uses the type of library that is installed on the system and, if it finds both the shared and the static versions, ``BUILD_SHARED_LIBS`` determines which one to link against.
When not specified as a component, the linking method is selected according to ``Z80_SHARED_LIBS``. If this option is not defined, the config-file uses the type of library that is installed on the system and, if it finds both the shared and the static versions, ``BUILD_SHARED_LIBS`` determines which one to link against.
As a CMake subproject
---------------------