README file for kforth for Linux

Copyright (c) 1999--2003 Creative Consulting for Research and Education
Last Revised: 04-15-2003

GENERAL
-------

kforth for Linux is provided under the terms of the GNU
General Public License. The license terms for this software 
are explained at our website:

http://ccreweb.org

New releases of this software will be posted at the website, as they
become available. Online documentation is also available at the website.
Further information may be obtained by sending e-mail to:

krishna.myneni@ccreweb.org

INSTALLATION 
------------

kforth is distributed as a compressed tar (Unix Tape Archive) file
with the name:

	kflnx-x.y.z.tar.gz

where x.y.z is the version number, e.g. 1.0.14.

This file contains the source code files and a Makefile for building
the executable. The GNU C/C++ development files are required to be
installed on your system. In addition, the 'readline' and 'ncurses'
libraries must be available.

Follow these steps to install kforth on your system:

1. Log in as the root user (superuser).

2. Create a directory for the kforth source files, typically
   in the /usr/local/src directory, e.g.

	mkdir /usr/local/src/kforth

3. Move the kforth archive file into this directory:

	mv kflnx-x.y.z.tar.gz /usr/local/src/kforth

4. Change to the /usr/local/src/kforth directory and extract the
   files:

	cd /usr/local/src/kforth
	tar -zxvf kflnx-x.y.z.tar.gz

   After this step, the directory should contain all of the kforth
   source files, the Makefile, and this README file.

5. Build the kforth executable. There are several options for
   building kforth, but the simplest is to type:

	make

   All of the source files will be compiled/assembled and the
   executable file, named "kforth", will be generated. 


6. Move the executable to a directory in the path for users:
	
	mv kforth /usr/local/bin

   Any user should then be able to execute kforth.

7. Sample source code files, with the extension ".4th", are
   included in the archive file. These files are inteded to
   serve as programming examples for kforth. Users may copy
   the .4th files into their directories.

8. You may specify a default directory in which kforth
   will search for .4th files not found in the current
   directory. The environment variable KFORTH_DIR must
   be set to this directory. For example, under the BASH
   shell, if you want the default directory to be 
   /usr/local/src/kforth, add the following lines to your
   .bash_profile file:

	KFORTH_DIR=/usr/local/src/kforth
	export KFORTH_DIR

9. The file kforth.xpm may be used to create a desktop icon
   for kforth under X Windows. For example, if you are using
   the KDE environment, copy kforth.xpm to the /usr/share/icons
   directory.

Contact CCRE via email at the email address given above if you 
have problems installing the software on your system.




