1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
\input texinfo
@comment %**start of header
@settitle FullSWOF-utils Reference Manual
@syncodeindex pg cp
@comment %**end of header
@copying
This document describes FullSWOF-utils, a set of utility scripts to be
used with the FullSWOF shallow flow solver.
Copyright @copyright{} 2019 Paul Garlick.
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
``GNU Free Documentation License''.
@end quotation
@end copying
@titlepage
@title FullSWOF-utils Reference Manual
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@contents
@ifnottex
@node Top
@top FullSWOF-utils
Utility scripts for the FullSWOF shallow flow solver
@end ifnottex
@menu
* Installation:: Installing FullSWOF-utils.
* GNU Free Documentation License:: The license of this manual.
* Index:: Complete Index.
@end menu
@node Installation, GNU Free Documentation License, Top, Top
@comment node-name, next, previous, up
@chapter Installation
@cindex chapter, installation
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:
@example
git clone http://cgit.tourbillion-technology.com/fullSWOF-utils
@end example
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:
@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
@include fdl-1.3.texi
@node Index
@unnumbered Index
@printindex cp
@bye
Local Variables:
mode: texinfo
TeX-master: t
End:
|
