]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve wording slightly. 447/head
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 16 Jan 2015 14:49:18 +0000 (08:49 -0600)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 16 Jan 2015 16:42:03 +0000 (10:42 -0600)
The existing instructions didn't make clear where the sources were located and
implicitly assumed that they are in the directory above the build
directory. This can be confusing.

(By suggestion of Joel Kulesza.)

README.md

index a49218748cb2cf19c35a8747e5b887e2e8f08696..3c5da8298eb00233f8909b7bb3b9d58e3c30ea14 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,11 +9,13 @@ to the complex data structures and algorithms required.
 For the impatient:
 ------------------
 
-Configure compile and install the deal.II library with:
+Let's say you've unpacked the .tar.gz file, or cloned the git repository into
+a directory /path/to/dealii/sources. Then configure, compile, and install the
+deal.II library with: 
 
     $ mkdir build
     $ cd build
-    $ cmake -DCMAKE_INSTALL_PREFIX=/path/where/deal.II/should/be/intalled/to ..
+    $ cmake -DCMAKE_INSTALL_PREFIX=/path/where/dealii/should/be/intalled/to /path/to/dealii/sources
     $ make install    (alternatively $ make -j<N> install)
     $ make test
 
@@ -23,9 +25,9 @@ A detailed *ReadME* can be found at ./doc/readme.html and
 Getting started:
 ----------------
 
-The tutorial steps are located under ./examples/
+The tutorial steps are located under examples/ of the installation.
 Information about the tutorial steps can be found at
-./doc/doxygen/tutorial/index.html or at http://www.dealii.org/.
+doc/doxygen/tutorial/index.html or at http://www.dealii.org/.
 
 License:
 --------

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.