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