Imported Upstream version 1.1.0
[debian/splat] / README
1      ===============================================================
2      * Welcome to SPLAT! -- A Terrain Analysis Tool for Unix/Linux *
3      ===============================================================
4
5 Requirements
6 ============
7 SPLAT! requires the libbzip2-1.0.1 (or later) compression library and
8 header files for successful compilation.  bzip2/libbzip2 is available
9 at: http://sources.redhat.com/bzip2/
10
11 SPLAT! also requires the zlib general purpose compression library.
12 Any recent version included with your Linux distribution should work
13 fine.  Note, however, that zlib version 1.1.3 contains a security
14 vulnerability that has been fixed in version 1.1.4.  The latest
15 version of zlib may be found at: http://www.gzip.org/zlib/
16 If you decide to build zlib, don't forget to invoke:
17
18         ./configure -s
19
20 to build zlib as a shared library.
21
22 If you wish to generate terrain and elevation profiles through SPLAT!,
23 you will also need gnuplot.  The latest version of gnuplot is available
24 at: http://www.gnuplot.info/
25
26 You will also need an application for viewing large PPM graphics
27 files generated by SPLAT!.  XV, ImageMagick, XPaint, and The GIMP
28 all perform this task well, especially The GIMP.
29
30 It goes without saying that a C++ compiler (gcc/g++) and math libraries
31 are also needed to build SPLAT!
32
33
34 Installation Instructions
35 =========================
36 Unpack the tar.gz file in a source code directory (such as /usr/src
37 under Slackware):
38
39         cd /usr/src
40         tar xvfz splat-1.1.0.tar.gz
41
42 This action will generate a subdirectory named splat, and probably
43 requires 'root' privileges to do so.
44
45 Next, cd to the splat directory:
46
47         cd splat
48
49 Invoke the configure script to build SPLAT! and related utilities:
50
51         ./configure
52
53 If you are 'root', SPLAT! and its related man page and utilities will
54 be installed after the compilation process is complete.  If not, you
55 will be prompted to su to 'root' and invoke the install script manually:
56
57         su root
58         Password:
59         ./install all
60         exit
61
62 It's THAT simple!  :-)
63  
64 Before running SPLAT!, carefully read the documentation located under
65 the splat-1.1.0/docs directory for information on the use of the program.
66
67 Remember, topography data must be downloaded and SPLAT Data Files must
68 be generated (using the postdownload or usgs2sdf utility) prior to using
69 SPLAT!  Instructions for doing so are included in the documentation.
70
71 It is important to realize that when analyzing coverage areas of
72 transmitters, repeaters, or cell sites, SPLAT Data Files need to be
73 available for the entire region surrounding the site(s) being analyzed
74 so an accurate and complete topography map can be generated.  It is
75 advised that you place all your SPLAT Data Files in a single directory,
76 and then create a file in your home directory called .splat_path that
77 contains the full path to that directory so SPLAT! can easily find them.
78
79 Please read the README file under the utils directory for information
80 on the utilities included with SPLAT!.
81
82 The latest announcements and information regarding SPLAT! software is
83 available at the SPLAT! Home Page:
84
85         http://www.qsl.net/kd2bd/splat.html
86
87 --
88 John A. Magliacane, KD2BD
89 January 24, 2004
90