From b1cbdaabf5dcc70de0741bcf27603150321668c3 Mon Sep 17 00:00:00 2001 From: Paul Garlick Date: Mon, 22 Jun 2020 13:15:10 +0100 Subject: doc: Add Installation chapter. * doc/fullswof-utils.texi (Installation): Add chapter. --- doc/fullswof-utils.texi | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) (limited to 'doc') diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi index d3b53f3..c42db94 100644 --- a/doc/fullswof-utils.texi +++ b/doc/fullswof-utils.texi @@ -41,32 +41,39 @@ Utility scripts for the FullSWOF shallow flow solver @menu -* First Chapter:: Number One. +* Installation:: Installing FullSWOF-utils. * GNU Free Documentation License:: The license of this manual. * Index:: Complete Index. @end menu -@node First Chapter -@chapter First Chapter - -@cindex chapter, first +@node Installation, GNU Free Documentation License, Top, Top +@comment node-name, next, previous, up +@chapter Installation -This is the first chapter. -@cindex index entry, another +@cindex chapter, installation -Here is a numbered list. +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, +from within a suitable working directory, execute the command: -@enumerate -@item -This is the first item. +@example +git clone http://cgit.tourbillion-technology.com/fullSWOF-utils +@end example -@item -This is the second item. -@end enumerate +A directory named @emph{fullSWOF-utils} will be created. To complete +the installation first change directory to the new @emph{fullSWOF-utils} +directory. Then execute the command: -@node Installation, GNU Free Documentation License, Top, Top -@comment node-name, next, previous, up +@example +make +@end example +This command will create the documentation for the package. The +documentation is available in two formats; GNU Info format and html. +The info file is located in the doc directory. The html file is located +in the manual directory. The info file may be read using the +@command{info} program. The html file may be read using any web browser. @node GNU Free Documentation License @appendix GNU Free Documentation License -- cgit