Merge pull request #1 from philburk/fix-readme
[pforth] / readme.txt
CommitLineData
bb6b2dcd 1README for pForth - a Portable ANS-like Forth written in ANSI 'C'\r
2\r
3by Phil Burk\r
e6231089 4with Larry Polansky, David Rosenboom and Darren Gibbs.\r
54b27a87 5Support for 64-bit cells by Aleksej Saushev.\r
bb6b2dcd 6\r
0befde02 7Last updated: December 23, 2014 V27\r
e6231089 8\r
f3c1e292 9Code for pForth is maintained on GitHub at:\r
0befde02
PB
10 https://github.com/philburk/pforth\r
11 \r
e6231089 12Documentation for pForth at:\r
970d32b5 13 http://www.softsynth.com/pforth/\r
e6231089 14\r
15For technical support please use the pForth forum at:\r
16 http://groups.google.com/group/pforthdev\r
970d32b5 17 \r
bb6b2dcd 18-- LEGAL NOTICE -----------------------------------------\r
19\r
20The pForth software code is dedicated to the public domain,\r
21and any third party may reproduce, distribute and modify\r
22the pForth software code or any derivative works thereof\r
23without any compensation or license. The pForth software\r
24code is provided on an "as is" basis without any warranty\r
25of any kind, including, without limitation, the implied\r
26warranties of merchantability and fitness for a particular\r
27purpose 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
47See pForth reference manual at:\r
48\r
a33d774e 49 http://www.softsynth.com/pforth/pf_ref.php\r
bb6b2dcd 50 \r
51-- How to run pForth ------------------------------------\r
52\r
53Once you have compiled and built the dictionary, just enter:\r
54 pforth\r
55\r
56To compile source code files use: INCLUDE filename\r
57\r
58To create a custom dictionary enter in pForth:\r
59 c" newfilename.dic" SAVE-FORTH\r
60The name must end in ".dic".\r
61\r
62To run PForth with the new dictionary enter in the shell:\r
63 pforth -dnewfilename.dic\r
64\r
65To run PForth and automatically include a forth file:\r
66 pforth myprogram.fth\r
67\r
68-- How to Test PForth ------------------------------------\r
69\r
70You can test the Forth without loading a dictionary\r
71which might be necessary if the dictionary can't be built.\r
72\r
73Enter: pforth -i\r
74In pForth, enter: 3 4 + .\r
75In pForth, enter: loadsys\r
76In pForth, enter: 10 0 do i . loop\r
77\r
78PForth comes with a small test suite. To test the Core words,\r
79you can use the coretest developed by John Hayes.\r
80\r
81Enter: pforth\r
82Enter: include tester.fth\r
83Enter: include coretest.fth\r
84\r
85To 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
92They will report the number of tests that pass or fail.\r