Annotation of gforth/README, revision 1.69

1.65      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.59      anton      11: Gforth runs under GNU, BSD, and similar systems, MS Windows, MacOS X,
                     12: OS/2, and DOS and should not be hard to port to other systems
                     13: supported by GCC. This version has been tested successfully on the
                     14: following platforms:
1.31      pazsan     15: 
1.69    ! pazsan     16:   i386-unknown-linux-gnu
1.63      anton      17:   x86_64-unknown-linux-gnu
1.68      pazsan     18:   i386-apple-darwin9.4.0
                     19:   x86_64-apple-darwin9.4.0
1.22      anton      20: 
1.58      anton      21: Read INSTALL for installation instructions from source, or INSTALL.DOS
                     22: for DOS, Windows, and OS/2 from source, or INSTALL.BINDIST if you have
                     23: a binary package distributed as .tar.gz or .zip file.  If you received
                     24: a self-installing executable, just run it and follow the instructions.
                     25: 
1.53      anton      26: To start the system, just say `gforth' (after installing it).
1.10      anton      27: 
1.42      anton      28: You can find new versions of Gforth at ftp://ftp.gnu.org/gnu/gforth/
                     29: and its mirrors or at
1.10      anton      30: 
1.12      anton      31: http://www.complang.tuwien.ac.at/forth/gforth/
1.10      anton      32: or
1.12      anton      33: ftp://ftp.complang.tuwien.ac.at/pub/forth/gforth/
1.10      anton      34: 
1.42      anton      35: The latter site also contains binary distributions of Gforth for some
1.14      anton      36: popular platforms.
1.1       anton      37: 
1.7       anton      38: If you want to work on Gforth, mail me. Tasks to be done can be found
                     39: in ToDo; but if you would like to do something not mentioned there,
                     40: it's ok, too. In any case, we would like to hear what you are
                     41: doing. The most important tasks IMO are the missing ANS Forth words,
                     42: the documentation and the foreign language interface for C.
1.4       anton      43: 
                     44: On popular request, here are the meanings of unusual file extensions:
                     45: 
1.25      pazsan     46: *.fs   Forth stream source file (include with "include <file>" from within
1.26      anton      47:         gforth, or start with "gforth <file1> <file2> ...")
1.25      pazsan     48: *.fi   Forth image files (start with "gforth -i <image file>")
                     49: *.fb   Forth blocks file (load with "use <block file> 1 load")
1.4       anton      50: *.i    C include files
                     51: *.ds   documenation source
                     52: *TAGS  etags files
1.1       anton      53: 
1.11      anton      54: A number of Forth source files are included in this package that are
                     55: not necessary for building Gforth. Not all of them are mentioned in
                     56: the rest of the documentation, so here's a short overview:
                     57: 
                     58: Add-ons:
                     59: code.fs random.fs more.fs ansi.fs colorize.fs
1.36      crook      60: oof.fs oofsampl.fs objects.fs blocked.fb tasker.fs
1.11      anton      61: 
                     62: Utilities:
1.19      anton      63: ans-report.fs etags.fs glosgen.fs filedump.fs
1.11      anton      64: 
                     65: Games:
                     66: tt.fs sokoban.fs
                     67: 
1.19      anton      68: Test programs (for testing Forth systems):
1.29      anton      69: test/*.fs
1.11      anton      70: 
                     71: Benchmarks:
1.24      anton      72: bubble.fs siev.fs matrix.fs fib.fs
1.11      anton      73: 
                     74: ANS Forth implementations of Gforth extensions:
1.12      anton      75: compat/*.fs other.fs
1.27      pazsan     76: 
1.30      anton      77: For discussions about Gforth, use the Usenet newsgroup
                     78: comp.lang.forth.  If you prefer not to post on Usenet, there is also a
1.41      anton      79: mailing list: GForth@ChaosSolutions.org.  To subscribe, send a mail to
1.61      anton      80: gforth-subscribe@chaossolutions.org with:
1.27      pazsan     81: 
                     82: subscribe GForth
                     83: 
1.47      anton      84: as the first and only line within the message body.  Submit bug
                     85: reports through
1.11      anton      86: 
1.47      anton      87: https://savannah.gnu.org/bugs/?func=addbug&group=gforth
                     88: 
                     89: (whether you post them or not).
1.11      anton      90: 
1.1       anton      91: - anton
1.6       anton      92: anton@mips.complang.tuwien.ac.at
1.18      pazsan     93: http://www.complang.tuwien.ac.at/anton/home.html
1.49      anton      94: -----
1.66      anton      95: Copyright (C) 1995,1996,1997,1998,2000,2003,2004,2006,2007 Free Software Foundation, Inc.
1.49      anton      96: 
                     97: This file is part of Gforth.
                     98: 
                     99: Gforth is free software; you can redistribute it and/or
                    100: modify it under the terms of the GNU General Public License
1.67      anton     101: as published by the Free Software Foundation, either version 3
1.49      anton     102: of the License, or (at your option) any later version.
                    103: 
                    104: This program is distributed in the hope that it will be useful,
                    105: but WITHOUT ANY WARRANTY; without even the implied warranty of
                    106: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.#See the
                    107: GNU General Public License for more details.
                    108: 
                    109: You should have received a copy of the GNU General Public License
1.67      anton     110: along with this program. If not, see http://www.gnu.org/licenses/.

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