]> git.tuebingen.mpg.de Git - paraslash.git/commitdiff
doc-page
authorAndre Noll <maan@tuebingen.mpg.de>
Thu, 12 Jun 2025 20:47:50 +0000 (22:47 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Thu, 12 Jun 2025 20:47:50 +0000 (22:47 +0200)
web/documentation.in.html

index 22cdafeb2a657d7133326ac8a6563bf804211723..652591ec47c4cf422d2da6acc437978e7edf17e4 100644 (file)
@@ -1,18 +1,20 @@
 <h1>Documentation</h1>
 <hr>
 
+<p> Everything Gshown here corresponds to the current <tt>master</tt> branch
+of the public git repository. </p>
 
 <h2> General information </h2>
 
-<ul>
-       <li> <a href="manual.html">user manual</a>,
-               Installation, Configuration and Usage.
-       </li>
-
-</ul>
+<p> If you are new to paraslash, start with the <a href="manual.html">user
+manual</a>, It covers installation, configuration and basic usage. </p>
 
 <h2> Manual pages </h2>
 
+<p> Each executable has its own manual page. If the paraslash package is
+already installed, the same information can be obtained by running a command
+such as <tt>man para_server</tt>. </p>
+
 <p>
        [<a href="para_server.man.html">para_server</a>]
        [<a href="para_audiod.man.html">para_audiod</a>]
@@ -60,9 +62,8 @@ subsystem. This selection is not exhaustive, though. </p>
 
 <p> The detailed description of each executable usually mentions relevant
 other object files which are linked into the executable. The comment of
-the main function talks about public functions defined elsewhere and called
-from this file. The comment also describes the tasks which are created and
-registered to the paraslash scheduler. </p>
+the main function talks about related functions defined elsewhere and also
+describes the tasks which are registered to the paraslash scheduler. </p>
 
 <p>
        [<a href="doxygen/html/server_8c.html">para_server</a>]