summaryrefslogtreecommitdiffstats
path: root/Help/guide/tutorial/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* Tutorial: Remove incorrect instructions from Step 5Betsy McPhail2021-01-141-57/+10
| | | | | | | The first section of Step 5 is not tested, incorrect, and not the recommended solution. Fixes: #21539
* Tutorial: Fix minor typo in index.rstfazl2021-01-041-1/+1
| | | | s/mqsqrt.h/mysqrt.h/
* Help: Cleanup guidesBetsy McPhail2020-09-251-0/+3
| | | | | | * Move sections to be same level as Introduction in "Using Dependecies" * Rename "Importing Exporting Targets" to "Importing Exporting Guide" * Add an Introduction header to the Tutorial and Importing Exporting Guide
* Merge topic 'tutorial-update'Brad King2020-07-231-0/+1
|\ | | | | | | | | | | | | 63af35019a Tutorial: Add missing `language` option to literalinclude Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5046
| * Tutorial: Add missing `language` option to literalincludeBetsy McPhail2020-07-221-0/+1
| |
* | Fix typos identified using codespellJean-Christophe Fillion-Robin2020-07-221-1/+1
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | See https://github.com/codespell-project/codespell#readme The following command was used: ``` codespell -q6 --skip="\ .git,\ *.json,\ ./Copyright.txt,\ ./Help/command/foreach.rst,\ ./Help/prop_test/REQUIRED_FILES.rst,\ ./Help/variable/CTEST_COVERAGE_COMMAND.rst,\ ./Modules/CMakeCheckCompilerFlagCommonPatterns.cmake,\ ./Modules/CMakeRCInformation.cmake,\ ./Modules/Internal/CPack/NSIS.template.in,\ ./Modules/FindMatlab.cmake,\ ./Modules/MatlabTestsRedirect.cmake,\ ./Modules/Platform/Windows-Clang.cmake,\ ./Modules/Platform/Windows-Intel-Fortran.cmake,\ ./Modules/Platform/Windows-MSVC.cmake,\ ./Source/CMakeVersion.cmake,\ ./Source/cmConvertMSBuildXMLToJSON.py,\ ./Source/cmCreateTestSourceList.cxx,\ ./Source/cmGlobalVisualStudio10Generator.cxx,\ ./Source/cmExportBuildFileGenerator.cxx,\ ./Source/cmExportInstallAndroidMKGenerator.cxx,\ ./Source/cmExportInstallFileGenerator.cxx,\ ./Source/cmExportSet.cxx,\ ./Source/cmExportTryCompileFileGenerator.cxx,\ ./Source/cmFindPackageCommand.cxx,\ ./Source/cmInstallCommand.cxx,\ ./Source/cmGeneratorExpressionLexer.cxx,\ ./Source/cmLocalVisualStudio7Generator.cxx,\ ./Source/cmOrderDirectories.cxx,\ ./Source/cmTarget.cxx,\ ./Source/kwsys/*,\ ./Source/QtDialog/CMakeSetupDialog.ui,\ ./Source/CPack/WiX/cmWIXRichTextFormatWriter.cxx,\ ./Source/CTest/cmParseCoberturaCoverage.h,\ ./Tests/CMakeTests/ImplicitLinkInfoTest.cmake.in,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/English.license.rtf,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/German.license.txt,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/German.menu.txt,\ ./Tests/RunCMake/GoogleTest/xml_output.cpp,\ ./Tests/RunCMake/Make/TargetMessages*,\ ./Utilities/*,\ " \ -L "\ dependees,\ endwhile,\ fo,\ filetest,\ helpfull,\ nd,\ objext,\ stoll,\ supercedes,\ superceded,\ vas,\ varn,\ " ```
* Tutorial: Clarify Steps 1, 2 and 3Betsy McPhail2020-07-171-23/+55
|
* Merge topic 'tutorial_install_when_built_static'Brad King2020-06-181-3/+3
|\ | | | | | | | | | | | | 0fdfd6bf37 Tutorial: Install correctly when built statically Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4906
| * Tutorial: Install correctly when built staticallyRobert Maynard2020-06-161-3/+3
| | | | | | | | When built statically we failed to install the SqrtLibrary
* | Tutorial: Correct Step9 wordingRobert Maynard2020-06-161-1/+1
|/ | | | on some platforms -fPIC is implicit so you won't get an error
* Tutorial: Clarify Step 5Betsy McPhail2020-04-231-2/+6
| | | | Fixes: #20619
* Tutorial: Update Step 5 to work on WindowsBetsy McPhail2020-02-271-1/+1
| | | | | | | `log` and `exp` should be found on Windows systems now, as expected. Update tests to be more specific in looking for the expected outcome of the tutorial.
* Help: Replace UTF-8 apostrophe with ascii apostropheBrad King2020-02-121-3/+3
| | | | | | Also replace UTF-8 graphical characters with simple dashes. Fixes: #20349
* Tutorial: Clarify Step 5Betsy McPhail2020-01-161-4/+10
|
* Tutorial: Improve "MultiPackage" exampleBetsy McPhail2020-01-101-33/+59
| | | | Rename to Step 12 and ensure that it follows Step 11
* Tutorial: Add links to relevant CMake documentationBetsy McPhail2020-01-091-126/+145
| | | | Add links for commands, properties and variables.
* Tutorial: replace Unicode EN DASH with ASCII dashArkadiusz Drabczyk2019-11-171-2/+2
| | | | | | | Unicode EN DASH is problematic: - it cannot be easily found in web browsers, editors etc. - it doesn't work when copied and run in the terminal
* Tutorial: clean up typos, grammar and formattingCraig Scott2019-11-041-63/+66
|
* Tutorial: Improve Step 9Betsy McPhail2019-08-191-2/+7
| | | | * Move USE_MYMATH from configured header to target_compile_definitions
* Tutorial: Improve Step 8Betsy McPhail2019-08-191-10/+13
| | | | | * Remove comments from CTestConfig.cmake * Update directions
* Tutorial: Improve Step 7Betsy McPhail2019-08-191-7/+16
| | | | * Update directions
* Tutorial: Improve Step 6Betsy McPhail2019-08-191-18/+24
| | | | | | * Print message when using the table * Remove duplicated comment * Remove HAVE_LOG and HAVE_EXP checks, use generated table instead
* Tutorial: Improve Step 5Betsy McPhail2019-08-191-19/+57
| | | | | | | | * Updated output message * Use 'target_compile_definitions' for HAVE_LOG and HAVE_EXP Previously, the change from using TutorialConfig.h to target_compile_definitions happened without explanation as part of Step 8.
* Tutorial: Improve Step 4Betsy McPhail2019-08-191-14/+22
| | | | * Clarify directions
* Tutorial: Improve Step 3Betsy McPhail2019-08-191-6/+19
| | | | * Move `option(USE_MYMATH...` to the same location in all CMakeLists files
* Tutorial: Improve Step 2Betsy McPhail2019-08-191-27/+33
| | | | | | | | * Fix typo in #include * Remove CMakeLists file that users should create * Clarify which files users are expected to create * Highlight the importance of configuring TutorialConfig.h.in after the MY_MATH option has been set
* Tutorial: Improve Step 1Betsy McPhail2019-08-191-47/+78
| | | | | | | | | | * Update minimum required version to 3.10 * Use VERSION argument to project command rather than separate variables * Replace `endif(USE_MYMATH)` with more modern `endif()` * Simplify the call to 'configure_file()' * Add comments to tutorial.cxx to use as anchors in documentation * Remove CMakeLists and TutorialConfig.h.in files that users should create. Consequently, remove Step1 from CMake tests.
* Tutorial: Improve Step 10 generator expression example.Robert Maynard2019-07-251-15/+35
| | | | | Use compiler flags and standard levels as the compelling argument for using generator expressions and interface libraries
* Tutorial: Updated to reference using cmake --installRobert Maynard2019-07-191-6/+8
| | | | | This is preferred over using `make install` as it allows for control over the install location, configuration, and component.
* Help: Add tutorial guide table of contentsBrad King2019-06-191-0/+4
|
* Help: Update tutorial to include text from CMake bookBetsy McPhail2019-06-191-0/+35
|
* Help: Populate tutorial guide textBetsy McPhail2019-06-191-0/+717
| | | | | | Migrate tutorial text from individual `directions.txt` files to the main tutorial document. Add some comments to source code to provide anchors for inclusion.
* Help: Add infrastructure for guide-level documentationBrad King2019-06-181-0/+2
Create a `Help/guide/` directory to hold guide-level documents. Build them in most documentation formats, but not as man pages. Initialize the guide directory with a placeholder for the tutorial.
generated by cgit v0.12 at 2025-01-09 12:52:13 (GMT)