| 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: April 24, 2018 V28 |
| 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 | Permission to use, copy, modify, and/or distribute this |
| 21 | software for any purpose with or without fee is hereby granted. |
| 22 | |
| 23 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
| 24 | WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
| 25 | WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL |
| 26 | THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR |
| 27 | CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING |
| 28 | FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF |
| 29 | CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| 30 | OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 31 | |
| 32 | -- Contents of SDK -------------------------------------- |
| 33 | |
| 34 | build - tools for building pForth on various platforms |
| 35 | build/unix - Makefile for unix |
| 36 | |
| 37 | csrc - pForth kernel in ANSI 'C' |
| 38 | csrc/pf_main.c - main() application for a standalone Forth |
| 39 | csrc/stdio - I/O code using basic stdio for generic platforms |
| 40 | csrc/posix - I/O code for Posix platform |
| 41 | csrc/win32 - I/O code for basic WIN32 platform |
| 42 | csrc/win32_console - I/O code for WIN32 console that supports command line history |
| 43 | |
| 44 | fth - Forth code |
| 45 | fth/util - utility functions |
| 46 | |
| 47 | -- How to build pForth ------------------------------------ |
| 48 | |
| 49 | See pForth reference manual at: |
| 50 | |
| 51 | http://www.softsynth.com/pforth/pf_ref.php |
| 52 | |
| 53 | -- How to run pForth ------------------------------------ |
| 54 | |
| 55 | Once you have compiled and built the dictionary, just enter: |
| 56 | pforth |
| 57 | |
| 58 | To compile source code files use: INCLUDE filename |
| 59 | |
| 60 | To create a custom dictionary enter in pForth: |
| 61 | c" newfilename.dic" SAVE-FORTH |
| 62 | The name must end in ".dic". |
| 63 | |
| 64 | To run PForth with the new dictionary enter in the shell: |
| 65 | pforth -dnewfilename.dic |
| 66 | |
| 67 | To run PForth and automatically include a forth file: |
| 68 | pforth myprogram.fth |
| 69 | |
| 70 | -- How to Test PForth ------------------------------------ |
| 71 | |
| 72 | You can test the Forth without loading a dictionary |
| 73 | which might be necessary if the dictionary can't be built. |
| 74 | |
| 75 | Enter: pforth -i |
| 76 | In pForth, enter: 3 4 + . |
| 77 | In pForth, enter: loadsys |
| 78 | In pForth, enter: 10 0 do i . loop |
| 79 | |
| 80 | PForth comes with a small test suite. To test the Core words, |
| 81 | you can use the coretest developed by John Hayes. |
| 82 | |
| 83 | Enter: pforth |
| 84 | Enter: include tester.fth |
| 85 | Enter: include coretest.fth |
| 86 | |
| 87 | To run the other tests, enter: |
| 88 | |
| 89 | pforth t_corex.fth |
| 90 | pforth t_strings.fth |
| 91 | pforth t_locals.fth |
| 92 | pforth t_alloc.fth |
| 93 | |
| 94 | They will report the number of tests that pass or fail. |