# --------------------------------- readme ---------------------------------

#
# This is part of the flight simulator 'fly8'.
# Author: Eyal Lebedinsky (eyal@ise.canberra.edu.au).
#

[A note on unpacking for Unix: It was decided to distribute these
sources as one bundle containing all supported platforms. Because
of the different end-of-line conventions used, ie. crlf in MSDOS and
lf in UNIX, it was also decided to distribute using crlf format.
Therefore, to unpack the sources for compilation on UNIX the crlf's must
be mapped to just lf's. This can be done in a couple of ways:

	- unpack on a PC and FTP the files to UNIX using ascii mode
	  transfer,

	- unpack on a PC then transfer using mtools "mread -t ...",
	  (for systems with MSDOS compatible floppy or hard disks
	  attached such as Linux or Suns)

	- use a crlf/lf mapping utility. A simple script called
	  'rmcr' is included to do this if all else fails. It uses
	  the UNIX 'tr -d ...' command so check before you use it.
          Run it as 'sh rmcr' in the fly directory.

The following files and directories are needed to build on Unix:

	fly/*
	fly/unix/*
	fly/shapes/*
	fly/parms/*
	fly/docs/*

All files in these directories are text files.
[RPJ]
]

To install fly8, unpack the archive in a directory called fly8 (or
whatever you prefer). You should have now the main directory with a
number of sub-directories for the different platforms and a DOCS
directory.

 The directories h, l, net, serial, u and v contain source, object
and library files for DOS.

 If you are installing on a supported platform then use that directory
and just add some extra switches to the programs when you find some
minor incompatibilities.

 If you are installing on a unix platform create a link in the top level:

ln -s unix UNIX

 If this is a new platform then create a new sub-directory and copy into
it the files from the most similar platform already supported.

 Now if you (say) are installing on a unix platform called MOON, do the
following:

1 Copy (or link) the file 'UNIX/makefile.top' to 'makefile' in the main
directory.

2 Edit 'makefile' so that these two lines now read:

SYSTEM= UNIX
XFLAGS= -D$(SYSTEM) -DMOON

 Also adjust the libs as needed (SCO needs -lsocket):

LIBS = -lm -lX11


3 'UNIX/makefile' does a 'ranlib'. If you do not use it then comment that
line.

(If building for MSDOS there are makefiles for MSC7 and QuickC in the
msdos, mswin, shapes and parms directories which need to be copied to
'makefile' in those directories. There are also makefile.top files.  [RPJ])

4 do 'make' in the main directory. Then do 'make install'.

 If all went ok then you now have 'fly8'. Try it by running 'fly' in the
install directory (you should have X active or else set the DISPLAY
environment variable to an X server display).

 If you have problems, edit as needed. Try and use '#ifdef MOON'
whenever possible. If you have to change anything in the main directory
then please email me about it. Also I will be glad to hear about any new
port.

 For all bug reports, suggestions, questions etc. contact me by email.

