]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Some more minor documentation cleanup
authormaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 4 Nov 2012 20:53:44 +0000 (20:53 +0000)
committermaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 4 Nov 2012 20:53:44 +0000 (20:53 +0000)
git-svn-id: https://svn.dealii.org/branches/branch_cmake@27355 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/readme.html

index e88f785728e868cc292b0425565ced8c34ac3beb..3b5918c619913b367fd61d1df8512c0c670b0efe 100644 (file)
     <h3>Unpacking</h3>
 
     <p>
-      The whole library usually comes as a .tar.gz file, that is a
-      tarred file archive which is compressed with gzip. After downloading it,
+      The whole library usually comes as a <code>.tar.gz</code> file,
+      which is a file archive compressed with gzip. After downloading it,
       unpack it using either
       <pre>
 
       or, if you have GNU tar with
       <pre>
 
-       tar xzf deal.II-X.Y.Z.tar.gz
+       tar -xvf deal.II-X.Y.Z.tar.gz
       </pre>
       <b>Note:</b> You will want to hang on to the source files
       of <acronym>deal.II</acronym> after installation as it makes developing
        make
        make install
       </pre>
-      These steps compile, link and install the deal.II libraries and should
-      take between a few minutes and an hour. Note the following:
+      These steps compile, link and install the deal.II libraries. The
+      whole process should take between a few minutes and an hour.<br />
+      <b>Note:</b>
       <ul>
        <li> <code>/path/install/dir</code> is the directory where you want to
          install the deal.II header files and libraries to. This can be a
          sources and recompile things, then you can remove
          the <code>build/</code> directory after the last step.
 
-       <li> The <acronym>deal.II</acronym> <code>cmake</code> system can accept a
+       <li> The <acronym>deal.II</acronym> <code>CMake</code> system can accept a
          significant number of configuration parameters. See the
          discussion <a href="#configuration-options">below</a>.
 
-       <li> If you are changing part of
-       the <acronym>deal.II</acronym> code itself, you can
-       re-compile the library using only the last two commands above
-       but in a previously created build directory. It is possible to
-       also change the configuration used in this directory by
-       calling <code>cmake</code> a second time, possibly with
-       different arguments. However, this sometimes leads to
-       surprising results and you may not get exactly what you were
-       hoping for. For more information, see <a href="cmake.html">here</a>.
+       <li> If you are changing part of the <acronym>deal.II</acronym>
+       code itself, you can re-compile the library using only the
+       last two commands above but in a previously created build
+       directory. It is also possible to change the configuration used
+       in this directory by calling <code>cmake</code> a second time,
+       possibly with different arguments.
+       However, this sometimes leads to surprising results and you may
+       not get exactly what you were hoping for. For more information,
+       see <a href="cmake.html">here</a>.
 
       </ul>
     </p>
       </ul>
     </p>
 
-    <p>
-      Apart from the libraries, the steps above install all necessary header
-      files you need to develop programs based on <acronym>deal.II</acronym>
-      as well as generate the full set of
-      documentation files so that it can be used locally on your computer. You
-      will then be able to access it through
-      <a href="documentation.html" target="body">this page</a>.
-    </p>
-
     <p>
       At this point, you have generated everything necessary to write
       programs based on <acronym>deal.II</acronym>. If you are new to
       <a href="doxygen/tutorial/index.html" target="_top">tutorial</a>.
     </p>
 
-
     <a name="configuration-options"></a>
     <h3>Configuration options</h3>
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.