Skip to content

Commit

Permalink
Documentation: Installation.
Browse files Browse the repository at this point in the history
  • Loading branch information
redcode committed Nov 20, 2023
1 parent 92b562c commit 8daaa13
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -91,16 +91,16 @@ If in doubt, read the CMake documentation for more information on configuration
options. The following are some of the most relevant standard options of CMake:

-DBUILD_SHARED_LIBS=(YES|NO)
Build the emulator as a shared library, rather than static.
Generate shared libraries rather than static libraries.
The default is `NO`.

-DCMAKE_BUILD_TYPE=(Debug|Release|RelWithDebInfo|MinSizeRel)
Choose the type of build (configuration) to generate.
The default is `Release`.

-DCMAKE_INSTALL_PREFIX="<path>"
Specify the installation prefix on UNIX and UNIX-like operating systems.
The default is `/usr/local`.
Specify the installation prefix.
The default is `/usr/local` (on UNIX and UNIX-like operating systems).

Package-specific options are prefixed with `Z80_` and can be divided into two
groups. The first one controls aspects not related to the source code of the
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,16 +378,16 @@ cmake -LAH
If in doubt, read the [CMake documentation](https://cmake.org/documentation/) for more information on configuration options. The following are some of the most relevant standard options of CMake:

* <span id="cmake_option_build_shared_libs">**<code>-D[BUILD_SHARED_LIBS](https://cmake.org/cmake/help/latest/variable/BUILD_SHARED_LIBS.html)=(YES|NO)</code>**</span>
Build the emulator as a shared library, rather than static.
Generate shared libraries rather than static libraries.
The default is `NO`.

* <span id="cmake_option_cmake_build_type">**<code>-D[CMAKE_BUILD_TYPE](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html)=(Debug|Release|RelWithDebInfo|MinSizeRel)</code>**</span>
Choose the type of build (configuration) to generate.
The default is `Release`.

* <span id="cmake_option_cmake_install_prefix">**<code>-D[CMAKE_INSTALL_PREFIX](https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html)="\<path\>"</code>**</span>
Specify the installation prefix on [UNIX](https://en.wikipedia.org/wiki/Unix) and [UNIX-like](https://en.wikipedia.org/wiki/Unix-like) operating systems.
The default is `"/usr/local"`.
Specify the installation prefix.
The default is `"/usr/local"` (on [UNIX](https://en.wikipedia.org/wiki/Unix) and [UNIX-like](https://en.wikipedia.org/wiki/Unix-like) operating systems).

<span id="cmake_package_options">Package-specific options</span> are prefixed with `Z80_` and can be divided into two groups. The first one controls aspects not related to the source code of the library:

Expand Down
6 changes: 3 additions & 3 deletions documentation/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ If in doubt, read the `CMake documentation <https://cmake.org/documentation/>`_

.. option:: -DBUILD_SHARED_LIBS=(YES|NO)

Build the emulator as a shared library, rather than static. |br| |nl|
Generate shared libraries rather than static libraries. |br| |nl|
The default is ``NO``.

.. option:: -DCMAKE_BUILD_TYPE=(Debug|Release|RelWithDebInfo|MinSizeRel)
Expand All @@ -61,8 +61,8 @@ If in doubt, read the `CMake documentation <https://cmake.org/documentation/>`_

.. option:: -DCMAKE_INSTALL_PREFIX="<path>"

Specify the installation prefix on `UNIX <https://en.wikipedia.org/wiki/Unix>`_ and `UNIX-like <https://en.wikipedia.org/wiki/Unix-like>`_ operating systems. |br| |nl|
The default is ``"/usr/local"``.
Specify the installation prefix. |br| |nl|
The default is ``"/usr/local"`` (on `UNIX <https://en.wikipedia.org/wiki/Unix>`_ and `UNIX-like <https://en.wikipedia.org/wiki/Unix-like>`_ operating systems).

.. _cmake_package_options:

Expand Down

0 comments on commit 8daaa13

Please sign in to comment.