From 62bc7adf5c9ade6f416bf44dbf18c9078c9aae92 Mon Sep 17 00:00:00 2001 From: bangerth Date: Mon, 12 Nov 2012 01:44:03 +0000 Subject: [PATCH] Adapt to cmake procedure. git-svn-id: https://svn.dealii.org/branches/branch_cmake@27517 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/examples/step-1/doc/intro.dox | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/deal.II/examples/step-1/doc/intro.dox b/deal.II/examples/step-1/doc/intro.dox index c3629d2973..2548ff87d4 100644 --- a/deal.II/examples/step-1/doc/intro.dox +++ b/deal.II/examples/step-1/doc/intro.dox @@ -79,15 +79,29 @@ should play with them. To this end, go to the examples/step-1 directory (or whatever the number of the tutorial is that you're interested in) and type @code + cmake . make make run @endcode -The first command compiles the sources into an executable, while the -second executes it (strictly speaking, make run will also +The first command sets up the files that describe which include files this +tutorial program depends on, how to compile it and how to run it. This command +should find the installed deal.II libraries as well that were generated when +you compiled and installed everything as described in the deal.II ReadMe file. +If this command should fail to find the deal.II library, then you need to +provide the path to the installation using the command +@code + cmake -DDEAL_II_DIR=/path/to/installed/deal.II . +@endcode +instead. + +The second of the commands above compiles the sources into an executable, while the +last one executes it (strictly speaking, make run will also compile the code if the executable doesn't exist yet, so you could -have skipped the first command if you wanted). This is all that's +have skipped the second command if you wanted). This is all that's needed to run the code and produce the output that is discussed in the -"Results" section of the tutorial programs. +"Results" section of the tutorial programs. This sequence needs to be repeated +in all of the tutorial directories you want to play with. When learning the library, you need to play with it and see what happens. To this end, open the examples/step-1/step-1.cc -- 2.39.5