From 8f6697ea5e0600e70e7c5af7791b3eb58b435bad Mon Sep 17 00:00:00 2001 From: redcode Date: Sun, 3 Jul 2022 07:13:45 +0200 Subject: [PATCH] Integration instructions. --- README | 15 +++++++-------- README.md | 8 ++++---- documentation/Integration.rst | 8 ++++---- 3 files changed, 15 insertions(+), 16 deletions(-) diff --git a/README b/README index fb7027c..c93f0b9 100644 --- a/README +++ b/README @@ -255,7 +255,7 @@ It is important to set the `Z80_SHARED_LIBS` option. Otherwise CMake will build the library type indicated by `BUILD_SHARED_LIBS`, which may not be the desired one. -4.3. Manual integration +4.3. Integrating the source code There are several macros that can be used to configure the source code of the library. You can define those you need in your build system or at the beginning @@ -268,8 +268,8 @@ Z80.h and Z80.c into the project: If used, it must also be defined before including the Z80.h header. #define Z80_STATIC - Needed for compiling and/or using the emulator as a static library or as - an internal part of other project. + Required to compile and/or use the emulator as a static library or as an + internal part of another project. If used, it must also be defined before including the Z80.h header. #define Z80_WITH_LOCAL_HEADER @@ -287,14 +287,13 @@ source code by predefining the following macros: #define Z80_WITH_UNOFFICIAL_RETI #define Z80_WITH_ZILOG_NMOS_LD_A_IR_BUG +Except for `Z80_DEPENDENCIES_HEADER`, the above macros do not need to be defined +as a boolean value; the source code only checks whether or not they are defined. + Please note that the activation of some these optional implementations affects the speed of the emulator due to various factors (read the documentation for more details). -As a final note, except for `Z80_DEPENDENCIES_HEADER`, the above macros do not -need to be set to a particular token when used, as the source code only checks -whether or not they are defined. - 5. License =========== @@ -313,4 +312,4 @@ with this library. If not, see . -------------------------------------------------------------------------------- -Last update: 2022-06-29 README EOF +Last update: 2022-07-03 README EOF diff --git a/README.md b/README.md index 3a099cd..cc64f7b 100644 --- a/README.md +++ b/README.md @@ -431,7 +431,7 @@ target_link_libraries(your-target Z80) It is important to set the [`Z80_SHARED_LIBS`](#option_z80_shared_libs) option. Otherwise CMake will build the library type indicated by [`BUILD_SHARED_LIBS`](https://cmake.org/cmake/help/latest/variable/BUILD_SHARED_LIBS.html), which may not be the desired one. -### Manual integration +### Integrating the source code There are several macros that can be used to configure the source code of the library. You can define those you need in your build system or at the beginning of the `Z80.c` file. The following ones allow you to configure the integration of `Z80.h` and `Z80.c` into the project: @@ -440,7 +440,7 @@ There are several macros that can be used to configure the source code of the li If used, it must also be defined before including the `Z80.h` header. * **`#define Z80_STATIC`** - Needed for compiling and/or using the emulator as a static library or as an internal part of other project. + Required to compile and/or use the emulator as a static library or as an internal part of another project. If used, it must also be defined before including the `Z80.h` header. * **`#define Z80_WITH_LOCAL_HEADER`** @@ -456,9 +456,9 @@ There are several macros that can be used to configure the source code of the li * **[`#define Z80_WITH_UNOFFICIAL_RETI`](#option_z80_with_unofficial_reti)** * **[`#define Z80_WITH_ZILOG_NMOS_LD_A_IR_BUG`](#option_z80_with_zilog_nmos_ld_a_ir_bug)** -Please note that the activation of some these optional implementations affects the speed of the emulator due to various factors (read the documentation for more details). +Except for `Z80_DEPENDENCIES_HEADER`, the above macros do not need to be defined as a boolean value; the source code only checks whether or not they are defined. -As a final note, except for `Z80_DEPENDENCIES_HEADER`, the above macros do not need to be set to a particular token when used, as the source code only checks whether or not they are defined. +Please note that the activation of some these optional implementations affects the speed of the emulator due to various factors (read the documentation for more details). # Showcase diff --git a/documentation/Integration.rst b/documentation/Integration.rst index 1a6e5d5..f6bc4b4 100644 --- a/documentation/Integration.rst +++ b/documentation/Integration.rst @@ -48,8 +48,8 @@ Example: It is important to set the ``Z80_SHARED_LIBS`` option. Otherwise CMake will build the library type indicated by ``BUILD_SHARED_LIBS``, which may not be the desired one. -Manual integration ------------------- +Integrating the source code +--------------------------- There are several macros that can be used to configure the source code of the library. You can define those you need in your build system or at the beginning of the ``Z80.c`` file. The following ones allow you to configure the integration of ``Z80.h`` and ``Z80.c`` into the project: @@ -60,7 +60,7 @@ There are several macros that can be used to configure the source code of the li .. c:macro:: Z80_STATIC - Needed for compiling and/or using the emulator as a static library or as an internal part of other project. |br| |nl| + Required to compile and/or use the emulator as a static library or as an internal part of another project. |br| |nl| If used, it must also be defined before including the ``Z80.h`` header. .. c:macro:: Z80_WITH_LOCAL_HEADER @@ -77,4 +77,4 @@ The second group of package-specific options, explained in the "Installation" se .. c:macro:: Z80_WITH_UNOFFICIAL_RETI .. c:macro:: Z80_WITH_ZILOG_NMOS_LD_A_IR_BUG -Except for ``Z80_DEPENDENCIES_HEADER``, the above macros do not need to be set to a particular token when used, as the source code only checks whether or not they are defined. +Except for ``Z80_DEPENDENCIES_HEADER``, the above macros do not need to be defined as a boolean value; the source code only checks whether or not they are defined.