git.gag.com Git - debian/pforth/blob - readme.txt

   1 README for pForth - a Portable ANS-like Forth written in ANSI 'C'
   2
   3 by Phil Burk
   4 with Larry Polansky, David Rosenboom and Darren Gibbs.
   5 Support for 64-bit cells by Aleksej Saushev.
   6
   7 Last updated: December 23, 2014 V27
   8
   9 Code for pForth is maintained on GitHub at:
  10   https://github.com/philburk/pforth
  11
  12 Documentation for pForth at:
  13   http://www.softsynth.com/pforth/
  14
  15 For technical support please use the pForth forum at:
  16   http://groups.google.com/group/pforthdev
  17
  18 -- LEGAL NOTICE -----------------------------------------
  19
  20 The pForth software code is dedicated to the public domain,
  21 and any third party may reproduce, distribute and modify
  22 the pForth software code or any derivative works thereof
  23 without any compensation or license.  The pForth software
  24 code is provided on an "as is" basis without any warranty
  25 of any kind, including, without limitation, the implied
  26 warranties of merchantability and fitness for a particular
  27 purpose and their equivalents under the laws of any jurisdiction.
  28
  29 -- Contents of SDK --------------------------------------
  30
  31     build - tools for building pForth on various platforms
  32     build/win32/vs2005 - Visual Studio 2005 Project and Solution
  33     build/unix - Makefile for unix
  34
  35     csrc - pForth kernel in ANSI 'C'
  36     csrc/pf_main.c - main() application for a standalone Forth
  37     csrc/stdio - I/O code using basic stdio for generic platforms
  38     csrc/posix - I/O code for Posix platform
  39     csrc/win32 - I/O code for basic WIN32 platform
  40     csrc/win32_console - I/O code for WIN32 console that supports command line history
  41
  42     fth - Forth code
  43     fth/util - utility functions
  44
  45 -- How to build pForth ------------------------------------
  46
  47 See pForth reference manual at:
  48
  49   http://www.softsynth.com/pforth/pf_ref.php
  50
  51 -- How to run pForth ------------------------------------
  52
  53 Once you have compiled and built the dictionary, just enter:
  54      pforth
  55
  56 To compile source code files use:    INCLUDE filename
  57
  58 To create a custom dictionary enter in pForth:
  59     c" newfilename.dic" SAVE-FORTH
  60 The name must end in ".dic".
  61
  62 To run PForth with the new dictionary enter in the shell:
  63     pforth -dnewfilename.dic
  64
  65 To run PForth and automatically include a forth file:
  66     pforth myprogram.fth
  67
  68 -- How to Test PForth ------------------------------------
  69
  70 You can test the Forth without loading a dictionary
  71 which might be necessary if the dictionary can't be built.
  72
  73 Enter:   pforth -i
  74 In pForth, enter:    3 4 + .
  75 In pForth, enter:    loadsys
  76 In pForth, enter:    10  0  do i . loop
  77
  78 PForth comes with a small test suite.  To test the Core words,
  79 you can use the coretest developed by John Hayes.
  80
  81 Enter:  pforth
  82 Enter:  include tester.fth
  83 Enter:  include coretest.fth
  84
  85 To run the other tests, enter:
  86
  87     pforth t_corex.fth
  88     pforth t_strings.fth
  89     pforth t_locals.fth
  90     pforth t_alloc.fth
  91
  92 They will report the number of tests that pass or fail.