added ? word as a convenience
[pforth] / readme.txt
index 569a836..de7cf90 100644 (file)
@@ -1,96 +1,92 @@
-README for pForth - a Portable ANS-like Forth written in ANSI 'C'\r
-\r
-by Phil Burk\r
-with Larry Polansky, David Rosenboom and Darren Gibbs.\r
-\r
-Last updated: Feb 20, 2009 V24\r
-
-Code for pForth is maintained on Google at:
-   http://code.google.com/p/pforth/
-   \r
+README for pForth - a Portable ANS-like Forth written in ANSI 'C'
+
+by Phil Burk
+with Larry Polansky, David Rosenboom and Darren Gibbs.
+Support for 64-bit cells by Aleksej Saushev.
+
+Last updated: December 23, 2014 V27
+
+Code for pForth is maintained on GitHub at:
+  https://github.com/philburk/pforth
 Documentation for pForth at:
 Documentation for pForth at:
-  http://www.softsynth.com/pforth/\r
+  http://www.softsynth.com/pforth/
 
 For technical support please use the pForth forum at:
   http://groups.google.com/group/pforthdev
 
 For technical support please use the pForth forum at:
   http://groups.google.com/group/pforthdev
-  \r
-The author is available for customization of pForth, porting to new\r
-platforms, or developing pForth applications on a contractual basis.\r
-If interested, contact Phil Burk at:
-  http://www.softsynth.com/contacts.php\r
-\r
--- LEGAL NOTICE -----------------------------------------\r
-\r
-The pForth software code is dedicated to the public domain,\r
-and any third party may reproduce, distribute and modify\r
-the pForth software code or any derivative works thereof\r
-without any compensation or license.  The pForth software\r
-code is provided on an "as is" basis without any warranty\r
-of any kind, including, without limitation, the implied\r
-warranties of merchantability and fitness for a particular\r
-purpose and their equivalents under the laws of any jurisdiction.\r
-\r
--- Contents of SDK --------------------------------------\r
-\r
-       build - tools for building pForth on various platforms\r
-       build/win32/vs2005 - Visual Studio 2005 Project and Solution\r
-       build/unix - Makefile for unix\r
-       \r
-       csrc - pForth kernel in ANSI 'C'\r
-       csrc/pf_main.c - main() application for a standalone Forth\r
-       csrc/stdio - I/O code using basic stdio for generic platforms\r
-       csrc/posix - I/O code for Posix platform\r
-       csrc/win32 - I/O code for basic WIN32 platform\r
-       csrc/win32_console - I/O code for WIN32 console that supports command line history\r
-       \r
-       fth - Forth code\r
-       fth/util - utility functions\r
-\r
--- How to build pForth ------------------------------------\r
-\r
-See pForth reference manual at:\r
-\r
-  http://www.softsynth.com/pforth/pf_ref.htm\r
-  \r
--- How to run pForth ------------------------------------\r
-\r
-Once you have compiled and built the dictionary, just enter:\r
-     pforth\r
-\r
-To compile source code files use:    INCLUDE filename\r
-\r
-To create a custom dictionary enter in pForth:\r
-       c" newfilename.dic" SAVE-FORTH\r
-The name must end in ".dic".\r
-\r
-To run PForth with the new dictionary enter in the shell:\r
-       pforth -dnewfilename.dic\r
-\r
-To run PForth and automatically include a forth file:\r
-       pforth myprogram.fth\r
-\r
--- How to Test PForth ------------------------------------\r
-\r
-You can test the Forth without loading a dictionary\r
-which might be necessary if the dictionary can't be built.\r
-\r
-Enter:   pforth -i\r
-In pForth, enter:    3 4 + .\r
-In pForth, enter:    loadsys\r
-In pForth, enter:    10  0  do i . loop\r
-\r
-PForth comes with a small test suite.  To test the Core words,\r
-you can use the coretest developed by John Hayes.\r
-\r
-Enter:  pforth\r
-Enter:  include tester.fth\r
-Enter:  include coretest.fth\r
-\r
-To run the other tests, enter:\r
-\r
-       pforth t_corex.fth\r
-       pforth t_strings.fth\r
-       pforth t_locals.fth\r
-       pforth t_alloc.fth\r
-       \r
-They will report the number of tests that pass or fail.\r
+  
+-- LEGAL NOTICE -----------------------------------------
+
+The pForth software code is dedicated to the public domain,
+and any third party may reproduce, distribute and modify
+the pForth software code or any derivative works thereof
+without any compensation or license.  The pForth software
+code is provided on an "as is" basis without any warranty
+of any kind, including, without limitation, the implied
+warranties of merchantability and fitness for a particular
+purpose and their equivalents under the laws of any jurisdiction.
+
+-- Contents of SDK --------------------------------------
+
+    build - tools for building pForth on various platforms
+    build/win32/vs2005 - Visual Studio 2005 Project and Solution
+    build/unix - Makefile for unix
+    
+    csrc - pForth kernel in ANSI 'C'
+    csrc/pf_main.c - main() application for a standalone Forth
+    csrc/stdio - I/O code using basic stdio for generic platforms
+    csrc/posix - I/O code for Posix platform
+    csrc/win32 - I/O code for basic WIN32 platform
+    csrc/win32_console - I/O code for WIN32 console that supports command line history
+    
+    fth - Forth code
+    fth/util - utility functions
+
+-- How to build pForth ------------------------------------
+
+See pForth reference manual at:
+
+  http://www.softsynth.com/pforth/pf_ref.php
+  
+-- How to run pForth ------------------------------------
+
+Once you have compiled and built the dictionary, just enter:
+     pforth
+
+To compile source code files use:    INCLUDE filename
+
+To create a custom dictionary enter in pForth:
+    c" newfilename.dic" SAVE-FORTH
+The name must end in ".dic".
+
+To run PForth with the new dictionary enter in the shell:
+    pforth -dnewfilename.dic
+
+To run PForth and automatically include a forth file:
+    pforth myprogram.fth
+
+-- How to Test PForth ------------------------------------
+
+You can test the Forth without loading a dictionary
+which might be necessary if the dictionary can't be built.
+
+Enter:   pforth -i
+In pForth, enter:    3 4 + .
+In pForth, enter:    loadsys
+In pForth, enter:    10  0  do i . loop
+
+PForth comes with a small test suite.  To test the Core words,
+you can use the coretest developed by John Hayes.
+
+Enter:  pforth
+Enter:  include tester.fth
+Enter:  include coretest.fth
+
+To run the other tests, enter:
+
+    pforth t_corex.fth
+    pforth t_strings.fth
+    pforth t_locals.fth
+    pforth t_alloc.fth
+    
+They will report the number of tests that pass or fail.