Commit Graph

12 Commits

Author SHA1 Message Date
Betsy McPhail
a36731c634 Tutorial: Improve Step 6
* Print message when using the table
* Remove duplicated comment
* Remove HAVE_LOG and HAVE_EXP checks, use generated table instead
2019-08-19 11:49:05 -04:00
Betsy McPhail
df9cdf629c Tutorial: Improve Step 5
* 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.
2019-08-19 11:49:05 -04:00
Betsy McPhail
442c0f0d46 Tutorial: Improve Step 4
* Clarify directions
2019-08-19 11:49:05 -04:00
Betsy McPhail
bc64401c3d Tutorial: Improve Step 3
* Move `option(USE_MYMATH...` to the same location in all CMakeLists files
2019-08-19 11:49:05 -04:00
Betsy McPhail
49ce4d6ff4 Tutorial: Improve Step 2
* 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
2019-08-19 11:49:05 -04:00
Betsy McPhail
82332f81bb Tutorial: Improve Step 1
* 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.
2019-08-19 11:48:58 -04:00
Robert Maynard
fa203ee323 Tutorial: Improve Step 10 generator expression example.
Use compiler flags and standard levels as the compelling argument
for using generator expressions and interface libraries
2019-07-25 07:30:13 -04:00
Robert Maynard
c94e62c07e 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.
2019-07-19 14:38:05 -04:00
Brad King
8ab8563533 Help: Add tutorial guide table of contents 2019-06-19 09:00:19 -04:00
Betsy McPhail
0a6c9c417a Help: Update tutorial to include text from CMake book 2019-06-19 08:59:31 -04:00
Betsy McPhail
eef3e020c2 Help: Populate tutorial guide text
Migrate tutorial text from individual `directions.txt` files to the main
tutorial document.  Add some comments to source code to provide anchors
for inclusion.
2019-06-19 08:57:12 -04:00
Brad King
d2fde94809 Help: Add infrastructure for guide-level documentation
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.
2019-06-18 10:36:16 -04:00