From e77d44ca29d86ec222735c41ee59146c033795f4 Mon Sep 17 00:00:00 2001 From: kanschat Date: Wed, 28 Aug 2013 06:42:07 +0000 Subject: [PATCH] pass validation git-svn-id: https://svn.dealii.org/trunk@30514 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/documentation.html | 3 +- deal.II/doc/readme.html | 442 ++++++++++++++++++--------------- 2 files changed, 239 insertions(+), 206 deletions(-) diff --git a/deal.II/doc/documentation.html b/deal.II/doc/documentation.html index 40baede90b..10620b4c56 100644 --- a/deal.II/doc/documentation.html +++ b/deal.II/doc/documentation.html @@ -2,8 +2,9 @@ "http://www.w3.org/TR/html4/loose.dtd"> - The deal.II Online Documentation + + diff --git a/deal.II/doc/readme.html b/deal.II/doc/readme.html index d9e5f3927f..6bec165b65 100644 --- a/deal.II/doc/readme.html +++ b/deal.II/doc/readme.html @@ -1,14 +1,16 @@ - - + + + The deal.II Readme - - - - - - + + + + + + + @@ -33,101 +35,105 @@
  1. System requirements
      -
    1. Supported platforms -
    2. Additional software requirements +
    3. Supported platforms
    4. +
    5. Additional software requirements
    +
  2. Installation
      -
    1. Unpacking -
    2. Configuring and building the library -
    3. Configuring and building the documentation +
    4. Unpacking
    5. +
    6. Configuring and building the library
    7. +
    8. Configuring and building the documentation
    9. Configuration options
        -
      1. Selecting optional behavior +
      2. Selecting optional behavior
      3. Optional interfaces to - other software packages + other software packages
      4. More information on configuring - and building the library + and building the library
      +
    -
  3. Problems, questions, mailing lists -
  4. License +
  5. +
  6. Problems, questions, mailing lists
  7. +
  8. License
- -

System requirements

- - -

Supported platforms

- -

- deal.II is mostly developed on Linux using the - GCC compiler. However, it is not - platform specific and we strive to keep the source code C++ - Standard compliant. -

- -

- deal.II supports at least the following - platforms: -

+

+ Most other combinations of POSIX-style operating systems and C++ + Standard compliant compilers should also work. If they don't, + please report it as a bug. +

-

- Please note that the Microsoft Visual C++ compiler, that is widely - used on Microsoft Windows, is not supported. If you need a native - Windows target, use the MinGW compiler instead. -

+

+ Please note that the Microsoft Visual C++ compiler, that is widely + used on Microsoft Windows, is not supported. If you need a native + Windows target, use the MinGW compiler instead. +

- -

Additional software requirements

+ +

Additional software requirements

In order to compile and use deal.II you need to have the following programs installed:

- - - - +

Installation

- -
+ +

Unpacking

The whole library usually comes as a tar.gz file, which is a file archive compressed with gzip. After downloading it, unpack it using either -

-
-	gunzip deal.II-X.Y.Z.tar.gz
-	tar xf deal.II-X.Y.Z.tar
-      
- or, if you have GNU tar with -
-
-	tar -xvf deal.II-X.Y.Z.tar.gz
-      
- Note: You will want to hang on to the source files - of deal.II after installation as it makes developing - much simpler. Consequently, you should do the steps above in a permanent - directory, not on /tmp as one often does when installing - software.

+
+  gunzip deal.II-X.Y.Z.tar.gz
+  tar xf deal.II-X.Y.Z.tar
+
+

or, if you have GNU tar with

+
+  tar -xvf deal.II-X.Y.Z.tar.gz
+
+ +

Note: You will want to hang on to the source files + of deal.II after installation as it makes + developing much simpler. Consequently, you should do the steps above + in a permanent directory, not on /tmp as one often does + when installing software. +

Configuring and building the library

@@ -214,21 +219,23 @@ CMake integrated configuration and build system. Unpacking will create a subdirectory deal.II/ in the current directory. Then do the - following steps: -
-
-	mkdir build
-	cd build
-	cmake -DCMAKE_INSTALL_PREFIX=/path/to/install/dir ../deal.II
-	make install
-      
- These steps compile, link and install the deal.II library. The - whole process should take between a few minutes and an hour, depending - on your machine. -

+ following steps:

+ +
+  mkdir build
+  cd build
+  cmake -DCMAKE_INSTALL_PREFIX=/path/to/install/dir ../deal.II
+  make install
+
+ +

+ These steps compile, link and install the deal.II library. The + whole process should take between a few minutes and an hour, depending + on your machine. +

- Note: + Note:

-

The commands above build and install the deal.II libraries in two variants: -