From: maier Date: Sat, 22 Sep 2012 17:33:24 +0000 (+0000) Subject: Update on the documentation X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e95466030175717b17a996a99182928d960b29b0;p=dealii-svn.git Update on the documentation git-svn-id: https://svn.dealii.org/branches/branch_cmake@26634 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/CMakeLists.txt b/deal.II/CMakeLists.txt index 69bd2a1864..f74daa9eff 100644 --- a/deal.II/CMakeLists.txt +++ b/deal.II/CMakeLists.txt @@ -68,8 +68,7 @@ OPTION(DEAL_II_FORCE_CONTRIB_BOOST OFF) OPTION(DEAL_II_WITH_DOXYGEN - "Enable the generation and installation of the documentation via doxygen. - This feature adds a COMPONENT \"documentation\" to the build system." + "Build deal.II with support for doxygen and dot." OFF) OPTION(DEAL_II_WITH_FUNCTIONPARSER diff --git a/deal.II/README_CMAKE b/deal.II/README_CMAKE index e136060418..e23297dc2a 100644 --- a/deal.II/README_CMAKE +++ b/deal.II/README_CMAKE @@ -12,323 +12,389 @@ -Table of contents +================= +TABLE OF CONTENTS ================= -The philosophy + Introduction -Quick start + The philosophy -Useful bits + Quick start -Feature configuration + Useful bits -Build configuration + Configuration -Installation + Feature configuration -Component selection + Component selection -Fat note regarding platform checks and feature configuration + Build configuration -Writing platform checks + Installation -Writing features + Development + Fat note regarding platform checks and feature configuration + Writing platform checks + Writing features -The philosophy -============== - »I need a new keyboard, my CAPS-KEY is stuck because of writing all - this cmake script...« -TODO +============ +INTRODUCTION +============ + TODO -Quick start -=========== + The philosophy + ============== -* Make a build directory, configure, compile and install: + »I need a new keyboard, my CAPS-KEY is stuck because of writing all + this cmake script...« - $ mkdir build - $ cd build - $ cmake -DCMAKE_INSTALL_PREFIX=/path/install/dir ../ - $ make install + TODO + Quick start + =========== -Useful bits -=========== + * Make a build directory, configure, compile and install: + $ mkdir build + $ cd build + $ cmake -DCMAKE_INSTALL_PREFIX=/path/install/dir ../ + $ make install -* All cached variables can be either set via - ( $ cd build ) - $ ccmake + Useful bits + =========== - or at the prompt via: - ( $ cd build ) - $ cmake -D