sourcenav README and INSTALL files.

sourcenav README and INSTALL files.

[Mo DeJong]

Here are a couple of file I whipped up to deal
with the lack of readme or install instructions
in the download. Could folks take a look at
them and see if there is anything that is
confusing or just plain missing?

thanks
Mo DeJong
Red Hat Inc

% cat README 
This is Source-Navigator and IDE for C/C++/Java/Tcl/Fortran and a host
of other languages. Source-Navigator includes powerful source code
comprehension features that help a developer understand complex
relationships between elements of a program's source.

Source-Navigator is GPLed free software, see the COPYING file
for more information about the GPL.

The Source-Navigator project is hosted at sources.redhat.com:

http://sources.redhat.com/sourcenav/

A public mailing list is available for help or general questions.
Go to the project website to find out how to join the mailing list.

One can find Source-Navigator documentation in the snavigator/doc/html
directory, it is available in HTML format only.

Consult the INSTALL file to learn how to build and install
binaries of Source-Navigator.



% cat INSTALL
Note: These build/install instructions assume that you have
already downloaded and extracted the files from the zip
or tar file.

Generic Build Notes:

We suggest building outside of the src directory, this might
be a new concept for most users, but it is really quite simple
once you get the hang of it. With a build dir, all build
related files for a specific architecture are stored outside
of the src directory, so you can build multiple executables
from the same source tree.

UNIX Build:

Building under UNIX systems is trivial, just create a
build dir and run the configure script. The following
commands assume the release is 5.0.1 and that the user
wants to install into a non-default location (/usr/sourcenav).

% mkdir snbuild ; cd snbuild
% ../sourcenav-5.0.1/configure --prefix=/usr/sourcenav
% make
% make install

Windows Build (VC++):

Building under Windows is more tricky when compared to the UNIX
build, be sure to follow the instructions exactly.

Windows versions of Source-Navigator are created using the VC++
compiler and Cygwin. One needs to run the vcvars32.bat script
to setup the needed env vars, typically this is done by starting
command.com on Windows 95/98 or cmd.exe under NT and then
running the vcvars32.bat script in the VC++ bin directory.

After VC++ env vars are setup, start a bash shell by cd'ing to
the Cygwin root directory and running cygwin.bat. In the bash
shell, run the following commands.

% export CC=cl
% export CFLAGS="-Z7 -Od"

You can now run the configure script in the normal way, but there
are a couple of things to watch for. First, the configure script
must be run with a relative path (../sourcenav-5.0.1/configure).
Second, the --prefix path must be passed as a Windows native path,
the following example assumes that /usr/sourcenav is mounted
as D:/Cygwin/usr/sourcenav.

% mkdir snbuild ; cd snbuild
% ../sourcenav-5.0.1/configure --prefix=D:/Cygwin/usr/sourcenav
% make
% make install


Binary Install:

Installing a binary release of SN is simple, just extract
the files from the archive, add the newly created
sourcenav-5.0.1/bin directory to your PATH, and then
type snavigator. Windows users can double-click on the
snavigator.exe executable in the Explorer.