File:  [gforth] / gforth / README
Revision 1.67: download - view: text, annotated - select for diffs
Mon Dec 31 18:40:23 2007 UTC (11 years, 7 months ago) by anton
Branches: MAIN
CVS tags: HEAD
updated copyright notices for GPL v3

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

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