Imported Upstream version 1.1.1
[debian/splat] / README
diff --git a/README b/README
index 2f0db5d63895c80dd903b87cfa300c7b86381c87..09f6e00db4a64175e0f62256a993587f3607338d 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,7 @@
-     ===============================================================
-     * Welcome to SPLAT! -- A Terrain Analysis Tool for Unix/Linux *
-     ===============================================================
+    ======================================================================
+    SPLAT!: A Terrestrial RF Path and Terrain Analysis Tool for Unix/Linux
+    ======================================================================
+
 
 Requirements
 ============
@@ -13,38 +14,38 @@ Any recent version included with your Linux distribution should work
 fine.  Note, however, that zlib version 1.1.3 contains a security
 vulnerability that has been fixed in version 1.1.4.  The latest
 version of zlib may be found at: http://www.gzip.org/zlib/
-If you decide to build zlib, don't forget to invoke:
+If you should decide to build zlib, don't forget to invoke:
 
        ./configure -s
 
 to build zlib as a shared library.
 
-If you wish to generate terrain and elevation profiles through SPLAT!,
-you will also need gnuplot.  The latest version of gnuplot is available
-at: http://www.gnuplot.info/
+If you wish to plot terrain and elevation profiles through SPLAT!,
+you will need gnuplot.  The latest version of gnuplot is available
+at: http://www.gnuplot.info/ if you don't already have it.
 
 You will also need an application for viewing large PPM graphics
 files generated by SPLAT!.  XV, ImageMagick, XPaint, and The GIMP
 all perform this task well, especially The GIMP.
 
 It goes without saying that a C++ compiler (gcc/g++) and math libraries
-are also needed to build SPLAT!
+are also needed to build SPLAT!  SPLAT! is fully compatible with the
+latest (4.1.x) versions of the GCC compiler.
 
 
 Installation Instructions
 =========================
 Unpack the tar.gz file in a source code directory (such as /usr/src
-under Slackware):
+under Slackware) as 'root':
 
        cd /usr/src
-       tar xvfz splat-1.1.0.tar.gz
+       tar xvfz splat-1.1.1.tar.gz
 
-This action will generate a subdirectory named splat, and probably
-requires 'root' privileges to do so.
+This action will generate a subdirectory named splat-1.1.1. 
 
-Next, cd to the splat directory:
+Next, cd into the directory:
 
-       cd splat
+       cd splat-1.1.1
 
 Invoke the configure script to build SPLAT! and related utilities:
 
@@ -59,32 +60,47 @@ will be prompted to su to 'root' and invoke the install script manually:
        ./install all
        exit
 
-It's THAT simple!  :-)
 Before running SPLAT!, carefully read the documentation located under
-the splat-1.1.0/docs directory for information on the use of the program.
+the splat-1.1.1/docs directory for information on the use of the program.
+
+REMEMBER: Topography data must be downloaded and SPLAT Data Files must
+be generated using the included srtm2sdf, postdownload, or usgs2sdf
+utilities before using SPLAT!  Instructions for doing so are included
+in the documentation.
+
+It is a good practice to create a working directory for SPLAT! use
+under your home directory:
+
+       mkdir $HOME/splat-work
 
-Remember, topography data must be downloaded and SPLAT Data Files must
-be generated (using the postdownload or usgs2sdf utility) prior to using
-SPLAT!  Instructions for doing so are included in the documentation.
+Then:
+       cd $HOME/splat-work
 
-It is important to realize that when analyzing coverage areas of
-transmitters, repeaters, or cell sites, SPLAT Data Files need to be
-available for the entire region surrounding the site(s) being analyzed
-so an accurate and complete topography map can be generated.  It is
-advised that you place all your SPLAT Data Files in a single directory,
-and then create a file in your home directory called .splat_path that
-contains the full path to that directory so SPLAT! can easily find them.
+before invoking SPLAT!
+
+In this manner, all associated SPLAT! working files can be kept in a
+common directory.
+
+It is important to realize that when analyzing regional coverage
+areas of transmitters, repeaters, or cell sites, SPLAT Data Files
+need to be available for the entire region surrounding the site(s)
+being analyzed.  SPLAT Data Files can be placed under your SPLAT!
+working directory, or under a separate directory specified in your
+$HOME/.splat_path file so SPLAT! can easily find them.
 
 Please read the README file under the utils directory for information
 on the utilities included with SPLAT!.
 
-The latest announcements and information regarding SPLAT! software is
-available at the SPLAT! Home Page:
+Please read the documentation under the splat-1.1.1/docs directory,
+or consult the program's man page for more information and examples
+of SPLAT! use.
+
+The latest announcements and information regarding SPLAT! software
+can be found on the SPLAT! Web Site:
 
        http://www.qsl.net/kd2bd/splat.html
 
 --
 John A. Magliacane, KD2BD
-January 24, 2004
+March 15, 2006