diff options
| author | Robert Maynard <robert.maynard@kitware.com> | 2019-07-18 14:19:12 -0400 |
|---|---|---|
| committer | Robert Maynard <robert.maynard@kitware.com> | 2019-07-19 14:38:05 -0400 |
| commit | c94e62c07eab14d6f36c18e11712d9d788fafd87 (patch) | |
| tree | cf96c796a560c5a2ed889b6e7147b00db9a26f9f /Help/guide/tutorial/index.rst | |
| parent | e3bd5c5b666e515319d81f8218e2f71c11169304 (diff) | |
| download | cmake-c94e62c07eab14d6f36c18e11712d9d788fafd87.tar.gz | |
Tutorial: Updated to reference using cmake --install
This is preferred over using `make install` as it allows for control
over the install location, configuration, and component.
Diffstat (limited to 'Help/guide/tutorial/index.rst')
| -rw-r--r-- | Help/guide/tutorial/index.rst | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/Help/guide/tutorial/index.rst b/Help/guide/tutorial/index.rst index db8e7a0c82..41ed0c4a2b 100644 --- a/Help/guide/tutorial/index.rst +++ b/Help/guide/tutorial/index.rst @@ -228,7 +228,8 @@ remove our uses of the ``EXTRA_INCLUDES`` variable from the top-level CMakeLists. 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) =============================== @@ -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. Run **cmake** or **cmake-gui** to configure the project and then build it -with your chosen build tool. Build the ``install`` target by typing -``make install`` from the command line or build the ``INSTALL`` target from -an IDE. This will install the appropriate header files, libraries, and -executables. +with your chosen build tool. Run the install step by typing +``cmake --install .`` or from the command line, or build the ``INSTALL`` +target from an IDE. This will install the appropriate header files, libraries, +and executables. Verify that the installed Tutorial runs. Note: The CMake variable ``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 --------------- |