Merge pull request #33 from ellerh/implement-resize-file
[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
7Last updated: December 23, 2014 V27
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
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
47See pForth reference manual at:
48
49 http://www.softsynth.com/pforth/pf_ref.php
50
51-- How to run pForth ------------------------------------
52
53Once you have compiled and built the dictionary, just enter:
54 pforth
55
56To compile source code files use: INCLUDE filename
57
58To create a custom dictionary enter in pForth:
59 c" newfilename.dic" SAVE-FORTH
60The name must end in ".dic".
61
62To run PForth with the new dictionary enter in the shell:
63 pforth -dnewfilename.dic
64
65To run PForth and automatically include a forth file:
66 pforth myprogram.fth
67
68-- How to Test PForth ------------------------------------
69
70You can test the Forth without loading a dictionary
71which might be necessary if the dictionary can't be built.
72
73Enter: pforth -i
74In pForth, enter: 3 4 + .
75In pForth, enter: loadsys
76In pForth, enter: 10 0 do i . loop
77
78PForth comes with a small test suite. To test the Core words,
79you can use the coretest developed by John Hayes.
80
81Enter: pforth
82Enter: include tester.fth
83Enter: include coretest.fth
84
85To 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
92They will report the number of tests that pass or fail.