Annotation of gforth/README, revision 1.71

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

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