Annotation of gforth/README, revision 1.77

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
1.77    ! anton       4: decompiler and a powerful locals facility, and it has a comprehensive
1.54      anton       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.77    ! anton      11: Gforth runs under GNU, BSD, and similar systems, MS Windows and MacOS X
        !            12: and should not be hard to port to other systems supported by GCC. This
        !            13: version has been tested successfully on the following platforms:
1.31      pazsan     14: 
1.74      anton      15: alpha-unknown-linux-gnu 
                     16:  gcc-2.95.2 19991024 (release)
                     17:  gcc-2.95.4 20011002 (Debian prerelease) 
                     18:  gcc-3.3.6 (Debian 1:3.3.6-15) 
                     19:  gcc-3.4.6 (Debian 3.4.6-5) 
                     20:  gcc-4.1.2 20061115 (prerelease) (Debian 4.1.1-21)
                     21: armv5l-unknown-linux-gnu 
                     22:  gcc-3.3.6 (Debian 1:3.3.6-15)
                     23:  broken: gcc-4.1.2 20061115 (prerelease) (Debian 4.1.1-21)
                     24:            <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=31152>
                     25: i686-pc-linux-gnu 
                     26:  gcc-2.95.4 20011002 (Debian prerelease) 
                     27:  gcc-3.3.5 (Debian 1:3.3.5-13) 
                     28:  gcc-3.4.4 20050314 (prerelease) (Debian 3.4.3-13sarge1)
                     29: ia64-hp-hpux11.23 
1.75      anton      30:  gcc-4.1.1
1.74      anton      31:  broken: gcc-3.4.3
                     32: powerpc-unknown-linux-gnu 
                     33:  gcc-2.95.4 20011002 (Debian prerelease) 
                     34:  gcc-3.2.3 (Debian) 
                     35:  gcc-3.3.6 (Debian 1:3.3.6-15) 
                     36:  gcc-3.4.6 (Debian 3.4.6-8) 
                     37:  gcc-4.0.3 20060128 (prerelease) (Debian 4.0.2-8) 
                     38:  gcc-4.1.3 20080623 (prerelease) (Debian 4.1.2-23) 
                     39:  gcc-4.3.2
                     40: powerpc64-unknown-linux-gnu 
                     41:  gcc-3.4.6 (Debian 3.4.6-5) 
                     42:  gcc-4.1.2 20061115 (prerelease) (Debian 4.1.1-21)
                     43: sparc-sun-solaris2.10 
                     44:  gcc-3.4.3 (csl-sol210-3_4-branch+sol_rpath) 
                     45:  gcc-4.0.2
                     46: x86_64-unknown-linux-gnu 
                     47:  gcc-3.3.6 (Debian 1:3.3.6-15) 
                     48:  gcc-3.4.6 (Debian 3.4.6-5) 
                     49:  gcc-4.0.0
                     50:  gcc-4.0.4 20060904 (prerelease) (Debian 4.0.3-7) 
                     51:  gcc-4.1.2 20061115 (prerelease) (Debian 4.1.1-21)
                     52:  gcc-4.1.3 20080623 (prerelease) (Debian 4.1.2-23) 
                     53:  gcc-4.2.0
                     54:  gcc-4.2.4 (Debian 4.2.4-3) 
                     55:  gcc-4.3.1
                     56: i386-apple-darwin9.4.0
                     57: x86_64-apple-darwin9.4.0
                     58: ppc-apple-darwin9.4.0
                     59: i686-pc-cygwin
                     60: gforth-ec: r8c, 4stack, misc, 8086
1.22      anton      61: 
1.58      anton      62: Read INSTALL for installation instructions from source, or INSTALL.DOS
                     63: for DOS, Windows, and OS/2 from source, or INSTALL.BINDIST if you have
                     64: a binary package distributed as .tar.gz or .zip file.  If you received
                     65: a self-installing executable, just run it and follow the instructions.
                     66: 
1.53      anton      67: To start the system, just say `gforth' (after installing it).
1.10      anton      68: 
1.42      anton      69: You can find new versions of Gforth at ftp://ftp.gnu.org/gnu/gforth/
                     70: and its mirrors or at
1.10      anton      71: 
1.12      anton      72: http://www.complang.tuwien.ac.at/forth/gforth/
1.10      anton      73: or
1.12      anton      74: ftp://ftp.complang.tuwien.ac.at/pub/forth/gforth/
1.10      anton      75: 
1.42      anton      76: The latter site also contains binary distributions of Gforth for some
1.14      anton      77: popular platforms.
1.1       anton      78: 
1.7       anton      79: If you want to work on Gforth, mail me. Tasks to be done can be found
                     80: in ToDo; but if you would like to do something not mentioned there,
                     81: it's ok, too. In any case, we would like to hear what you are
1.72      anton      82: doing. The most important task IMO is the foreign language interface
                     83: for C.
1.4       anton      84: 
                     85: On popular request, here are the meanings of unusual file extensions:
                     86: 
1.25      pazsan     87: *.fs   Forth stream source file (include with "include <file>" from within
1.26      anton      88:         gforth, or start with "gforth <file1> <file2> ...")
1.25      pazsan     89: *.fi   Forth image files (start with "gforth -i <image file>")
                     90: *.fb   Forth blocks file (load with "use <block file> 1 load")
1.4       anton      91: *.i    C include files
                     92: *.ds   documenation source
                     93: *TAGS  etags files
1.1       anton      94: 
1.11      anton      95: A number of Forth source files are included in this package that are
                     96: not necessary for building Gforth. Not all of them are mentioned in
                     97: the rest of the documentation, so here's a short overview:
                     98: 
                     99: Add-ons:
                    100: code.fs random.fs more.fs ansi.fs colorize.fs
1.36      crook     101: oof.fs oofsampl.fs objects.fs blocked.fb tasker.fs
1.11      anton     102: 
                    103: Utilities:
1.19      anton     104: ans-report.fs etags.fs glosgen.fs filedump.fs
1.11      anton     105: 
                    106: Games:
                    107: tt.fs sokoban.fs
                    108: 
1.19      anton     109: Test programs (for testing Forth systems):
1.29      anton     110: test/*.fs
1.11      anton     111: 
                    112: Benchmarks:
1.24      anton     113: bubble.fs siev.fs matrix.fs fib.fs
1.11      anton     114: 
                    115: ANS Forth implementations of Gforth extensions:
1.72      anton     116: compat/*.fs
1.27      pazsan    117: 
1.30      anton     118: For discussions about Gforth, use the Usenet newsgroup
                    119: comp.lang.forth.  If you prefer not to post on Usenet, there is also a
1.41      anton     120: mailing list: GForth@ChaosSolutions.org.  To subscribe, send a mail to
1.61      anton     121: gforth-subscribe@chaossolutions.org with:
1.27      pazsan    122: 
                    123: subscribe GForth
                    124: 
1.72      anton     125: as the first and only line within the message body.  You can also
                    126: report bugs through these channels, or you can report them through our
                    127: bug database:
1.11      anton     128: 
1.47      anton     129: https://savannah.gnu.org/bugs/?func=addbug&group=gforth
                    130: 
1.1       anton     131: - anton
1.6       anton     132: anton@mips.complang.tuwien.ac.at
1.18      pazsan    133: http://www.complang.tuwien.ac.at/anton/home.html
1.49      anton     134: -----
1.76      anton     135: Copyright (C) 1995,1996,1997,1998,2000,2003,2004,2006,2007,2008 Free Software Foundation, Inc.
1.49      anton     136: 
                    137: This file is part of Gforth.
                    138: 
                    139: Gforth is free software; you can redistribute it and/or
                    140: modify it under the terms of the GNU General Public License
1.67      anton     141: as published by the Free Software Foundation, either version 3
1.49      anton     142: of the License, or (at your option) any later version.
                    143: 
                    144: This program is distributed in the hope that it will be useful,
                    145: but WITHOUT ANY WARRANTY; without even the implied warranty of
                    146: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.#See the
                    147: GNU General Public License for more details.
                    148: 
                    149: You should have received a copy of the GNU General Public License
1.67      anton     150: along with this program. If not, see http://www.gnu.org/licenses/.

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