Annotation of gforth/README, revision 1.57

1.7       anton       1: Gforth is a fast and portable implementation of the ANS Forth
1.8       anton       2: language. It works nicely with the Emacs editor, offers some nice
1.54      anton       3: features such as input completion and history, backtraces, a
                      4: decompiler and a powerful locals facility, and it even has a
                      5: manual. Gforth combines traditional implementation techniques with
1.56      anton       6: newer techniques for portability and performance: its inner
                      7: interpreter is direct threaded with several optimizations, but you can
                      8: also use a traditional-style indirect threaded interpreter.  Gforth is
                      9: distributed under the GNU General Public license (see COPYING).
1.8       anton      10: 
1.57    ! anton      11: Gforth runs under Unix, MS Windows, MacOS X, OS/2, and DOS and should
        !            12: not be hard to port to other systems supported by GCC. This version
        !            13: has been tested successfully on the following platforms:
1.31      pazsan     14: 
1.55      anton      15:  alpha-dec-osf4.0d
                     16:  alpha-unknown-linux-gnu
                     17:  alphapca56-unknown-linux-gnu
                     18:  hppa1.1-unknown-linux-gnu
                     19:  hppa2.0n-hp-hpux11.00
                     20:  hppa2.0w-hp-hpux11.11
                     21:  i386-unknown-freebsd5.1
                     22:  i686-pc-cygwin
                     23:  i686-pc-linux-gnu
                     24:  mips-sgi-irix6.5
                     25:  mipsel-pc-linux-gnu
                     26:  powerpc-apple-darwin5.4
                     27:  powerpc-unknown-linux-gnu
                     28:  sparc-sun-sunos4.1.4
                     29:  sparc-unknown-linux-gnu
1.22      anton      30: 
1.37      anton      31: Read INSTALL for installation instructions, or INSTALL.DOS for DOS,
1.56      anton      32: Windows, and OS/2, or INSTALL.BINDIST if you have a binary package.
1.53      anton      33: To start the system, just say `gforth' (after installing it).
1.10      anton      34: 
1.42      anton      35: You can find new versions of Gforth at ftp://ftp.gnu.org/gnu/gforth/
                     36: and its mirrors or at
1.10      anton      37: 
1.12      anton      38: http://www.complang.tuwien.ac.at/forth/gforth/
1.10      anton      39: or
1.12      anton      40: ftp://ftp.complang.tuwien.ac.at/pub/forth/gforth/
1.10      anton      41: 
1.42      anton      42: The latter site also contains binary distributions of Gforth for some
1.14      anton      43: popular platforms.
1.1       anton      44: 
1.7       anton      45: If you want to work on Gforth, mail me. Tasks to be done can be found
                     46: in ToDo; but if you would like to do something not mentioned there,
                     47: it's ok, too. In any case, we would like to hear what you are
                     48: doing. The most important tasks IMO are the missing ANS Forth words,
                     49: the documentation and the foreign language interface for C.
1.4       anton      50: 
                     51: On popular request, here are the meanings of unusual file extensions:
                     52: 
1.25      pazsan     53: *.fs   Forth stream source file (include with "include <file>" from within
1.26      anton      54:         gforth, or start with "gforth <file1> <file2> ...")
1.25      pazsan     55: *.fi   Forth image files (start with "gforth -i <image file>")
                     56: *.fb   Forth blocks file (load with "use <block file> 1 load")
1.4       anton      57: *.i    C include files
                     58: *.ds   documenation source
                     59: *TAGS  etags files
1.1       anton      60: 
1.11      anton      61: A number of Forth source files are included in this package that are
                     62: not necessary for building Gforth. Not all of them are mentioned in
                     63: the rest of the documentation, so here's a short overview:
                     64: 
                     65: Add-ons:
                     66: code.fs random.fs more.fs ansi.fs colorize.fs
1.36      crook      67: oof.fs oofsampl.fs objects.fs blocked.fb tasker.fs
1.11      anton      68: 
                     69: Utilities:
1.19      anton      70: ans-report.fs etags.fs glosgen.fs filedump.fs
1.11      anton      71: 
                     72: Games:
                     73: tt.fs sokoban.fs
                     74: 
1.19      anton      75: Test programs (for testing Forth systems):
1.29      anton      76: test/*.fs
1.11      anton      77: 
                     78: Benchmarks:
1.24      anton      79: bubble.fs siev.fs matrix.fs fib.fs
1.11      anton      80: 
                     81: ANS Forth implementations of Gforth extensions:
1.12      anton      82: compat/*.fs other.fs
1.27      pazsan     83: 
1.30      anton      84: For discussions about Gforth, use the Usenet newsgroup
                     85: comp.lang.forth.  If you prefer not to post on Usenet, there is also a
1.41      anton      86: mailing list: GForth@ChaosSolutions.org.  To subscribe, send a mail to
1.45      anton      87: gforth-subscribe@chaossolutions.org@ChaosSolutions.org with:
1.27      pazsan     88: 
                     89: subscribe GForth
                     90: 
1.47      anton      91: as the first and only line within the message body.  Submit bug
                     92: reports through
1.11      anton      93: 
1.47      anton      94: https://savannah.gnu.org/bugs/?func=addbug&group=gforth
                     95: 
                     96: (whether you post them or not).
1.11      anton      97: 
1.1       anton      98: - anton
1.6       anton      99: anton@mips.complang.tuwien.ac.at
1.18      pazsan    100: http://www.complang.tuwien.ac.at/anton/home.html
1.49      anton     101: -----
1.50      anton     102: Copyright (C) 1995,1996,1997,1998,2000,2003 Free Software Foundation, Inc.
1.49      anton     103: 
                    104: This file is part of Gforth.
                    105: 
                    106: Gforth is free software; you can redistribute it and/or
                    107: modify it under the terms of the GNU General Public License
                    108: as published by the Free Software Foundation; either version 2
                    109: of the License, or (at your option) any later version.
                    110: 
                    111: This program is distributed in the hope that it will be useful,
                    112: but WITHOUT ANY WARRANTY; without even the implied warranty of
                    113: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.#See the
                    114: GNU General Public License for more details.
                    115: 
                    116: You should have received a copy of the GNU General Public License
                    117: along with this program; if not, write to the Free Software
                    118: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>