]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify something in the readme file that seems to perpetually perplex people. 8626/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Fri, 23 Aug 2019 03:01:15 +0000 (21:01 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Fri, 23 Aug 2019 03:01:15 +0000 (21:01 -0600)
doc/readme.html

index 71a49c06538697ca594d3525f3b0c3e9df35a087..5c54bb5a1c94f92004268d8bd3d626c3c9f054e7 100644 (file)
   cd build
   cmake -DCMAKE_INSTALL_PREFIX=/path/to/install/dir ../deal.II
     </pre>
-    We recommend compiling deal.II in parallel if your machine has more than one processor core. This can be done by providing the <code>--jobs</code> flag to <code>make</code> with a numerical argument. Here we compile with four <code>make</code> jobs:
+    We recommend compiling deal.II in parallel if your machine has
+    more than one processor core. This can be done by providing
+    the <code>--jobs=N</code> flag to <code>make</code> with a
+    numerical argument <code>N</code>. (The
+    argument <code>--jobs=N</code> is often abbreviated
+    as <code>-jN</code>.) Here we compile with four <code>make</code>
+    jobs:
     <pre>
   make --jobs=4 install
   make test
     </p>
 
     <p>
-        <b>Note:</b></p>
+        <b>Notes:</b></p>
     <ul>
-        <li> <code>/path/to/install/dir</code> is the directory which deal.II should be installed into. This can be a directory in your home directory (e.g., <code>~/bin/deal.II</code>) or a directory such as <code>/usr/local</code> if you have root privileges.
+        <li> The part "<code>/path/to/install/dir</code>" in the
+            command above needs to be replaced by the path to the directory which deal.II should be installed into. This can be a directory in your home directory (e.g., <code>~/bin/deal.II</code>) or a directory such as <code>/usr/local</code> if you have root privileges.
             Another option is to use something like <code>`pwd`/../installed/</code> (note the backticks). 
         </li>
 

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.