mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-17 20:50:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

Tutorial: Updated to reference using cmake --install

Browse Source 
This is preferred over using `make install` as it allows for control
over the install location, configuration, and component.
This commit is contained in:
Robert Maynard
2019-07-18 14:19:12 -04:00
parent e3bd5c5b66
commit c94e62c07e
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Help/guide/tutorial/index.rst
View File

@@ -228,7 +228,8 @@ remove our uses of the ``EXTRA_INCLUDES`` variable from the top-level
CMakeLists. CMakeLists.
Once this is done, run **cmake** or **cmake-gui** to configure the project Once this is done, run **cmake** or **cmake-gui** to configure the project
and then build it with your chosen build tool. and then build it with your chosen build tool or by using ``cmake --build .``
from the build directory.
Installing and Testing (Step 4) Installing and Testing (Step 4)
=============================== ===============================
@@ -258,14 +259,15 @@ And the to top-level ``CMakeLists.txt`` we add:
That is all that is needed to create a basic local install of the tutorial. That is all that is needed to create a basic local install of the tutorial.
Run **cmake** or **cmake-gui** to configure the project and then build it Run **cmake** or **cmake-gui** to configure the project and then build it
with your chosen build tool. Build the ``install`` target by typing with your chosen build tool. Run the install step by typing
``make install`` from the command line or build the ``INSTALL`` target from ``cmake --install .`` or from the command line, or build the ``INSTALL``
an IDE. This will install the appropriate header files, libraries, and target from an IDE. This will install the appropriate header files, libraries,
executables. and executables.
Verify that the installed Tutorial runs. Note: The CMake variable Verify that the installed Tutorial runs. Note: The CMake variable
``CMAKE_INSTALL_PREFIX`` is used to determine the root of where the files will ``CMAKE_INSTALL_PREFIX`` is used to determine the root of where the files will
be installed. be installed. If using ``cmake --install`` a custom installation directory can
be given via ``--prefix`` argument.
Testing Support Testing Support
--------------- ---------------