summaryrefslogtreecommitdiffstats
path: root/Help/guide/tutorial/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* 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.