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