diff options
| author | Paul Garlick <pgarlick@tourbillion-technology.com> | 2020-06-23 16:10:43 +0100 | 
|---|---|---|
| committer | Paul Garlick <pgarlick@tourbillion-technology.com> | 2020-06-23 16:10:43 +0100 | 
| commit | b44b6de8d91352bb5d5ad114a4de1c7976e94301 (patch) | |
| tree | 8d36be953aafa5ca466f4e90bbe12ca77d06feab /doc | |
| parent | 8fd5ae89c9f2211991bb254d4d2e2c205912ed01 (diff) | |
| download | fullSWOF-utils-b44b6de8d91352bb5d5ad114a4de1c7976e94301.tar.gz | |
doc: Split Installation chapter into sections.
* doc/fullswof-utils.texi (Installation):  Add 'Requirements' and
'Cloning' sections.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/fullswof-utils.texi | 34 | 
1 files changed, 32 insertions, 2 deletions
| diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi index 316a00f..2677b80 100644 --- a/doc/fullswof-utils.texi +++ b/doc/fullswof-utils.texi @@ -41,9 +41,9 @@ Utility scripts for the FullSWOF shallow flow solver  @menu -* Installation::                    Installing FullSWOF-utils. +* Installation::                Installing FullSWOF-utils.  * GNU Free Documentation License::  The license of this manual. -* Index::                           Complete Index. +* Index::                       Complete Index.  @end menu  @node Installation, GNU Free Documentation License, Top, Top @@ -52,6 +52,36 @@ Utility scripts for the FullSWOF shallow flow solver  @cindex chapter, installation +The @emph{fullSWOF-utils} package comprises a single top-level directory +and several sub-directories.  The package may be installed in the same +location as @emph{FullSWOF} itself or any other convenient location. + +@menu +* Requirements:: +* Cloning:: +@end menu + +@node Requirements, Cloning, Installation, Installation +@comment  node-name,  next,  previous,  up +@section Requirements + +To install @emph{fullSWOF-utils} the following packages are required: + +@itemize +@item +@url{https://git-scm.com/, Git}, the version control system. + +@item +@url{https://www.gnu.org/software/texinfo/, Texinfo}, the GNU +documentation system. +@end itemize + + + +@node Cloning,  , Requirements, Installation +@comment  node-name,  next,  previous,  up +@section Cloning +  FullSWOF-utils is maintained using git, the version control system.  A  simple way to install the package is to clone the git repository.  To do so,  first open a terminal window on a system that has git installed.  Then, | 
