xref: /illumos-gate/usr/src/common/ficl/ReadMe.txt (revision afc2ba1d)
1*afc2ba1dSToomas SoomeFICL 4.1.0
2*afc2ba1dSToomas SoomeOctober 2010
3*afc2ba1dSToomas Soome
4*afc2ba1dSToomas Soome________
5*afc2ba1dSToomas SoomeOVERVIEW
6*afc2ba1dSToomas Soome
7*afc2ba1dSToomas SoomeFicl is a complete programming language interpreter designed to be embedded
8*afc2ba1dSToomas Soomeinto other systems (including firmware based ones) as a command, macro,
9*afc2ba1dSToomas Soomeand development prototype language.  Ficl stands for "Forth Inspired
10*afc2ba1dSToomas SoomeCommand Language".
11*afc2ba1dSToomas Soome
12*afc2ba1dSToomas SoomeFor more information, please see the "doc" directory.
13*afc2ba1dSToomas SoomeFor release notes, please see "doc/releases.html".
14*afc2ba1dSToomas Soome
15*afc2ba1dSToomas Soome____________
16*afc2ba1dSToomas SoomeINSTALLATION
17*afc2ba1dSToomas Soome
18*afc2ba1dSToomas SoomeFicl builds out-of-the-box on the following platforms:
19*afc2ba1dSToomas Soome	* NetBSD, FreeBSD: use "Makefile".
20*afc2ba1dSToomas Soome	* Linux: use "Makefile.linux", but it should work with
21*afc2ba1dSToomas Soome	  "Makefile" as well.
22*afc2ba1dSToomas Soome	* Win32: use "ficl.dsw" / "ficl.dsp".
23*afc2ba1dSToomas SoomeTo port to other platforms, we suggest you start with the generic
24*afc2ba1dSToomas Soome"Makefile" and the "unix.c" / "unix.h" platform-specific implementation
25*afc2ba1dSToomas Soomefiles.  (And please--feel free to submit your portability changes!)
26*afc2ba1dSToomas Soome
27*afc2ba1dSToomas Soome(Note: Ficl used to build under RiscOS, but we broke everything
28*afc2ba1dSToomas Soomefor the 4.0 release.  Please fix it and send us the diffs!)
29*afc2ba1dSToomas Soome
30*afc2ba1dSToomas Soome____________
31*afc2ba1dSToomas SoomeFICL LICENSE
32*afc2ba1dSToomas Soome
33*afc2ba1dSToomas SoomeRedistribution and use in source and binary forms, with or without
34*afc2ba1dSToomas Soomemodification, are permitted provided that the following conditions
35*afc2ba1dSToomas Soomeare met:
36*afc2ba1dSToomas Soome1. Redistributions of source code must retain the above copyright
37*afc2ba1dSToomas Soome   notice, this list of conditions and the following disclaimer.
38*afc2ba1dSToomas Soome2. Redistributions in binary form must reproduce the above copyright
39*afc2ba1dSToomas Soome   notice, this list of conditions and the following disclaimer in the
40*afc2ba1dSToomas Soome   documentation and/or other materials provided with the distribution.
41*afc2ba1dSToomas Soome
42*afc2ba1dSToomas SoomeTHIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
43*afc2ba1dSToomas SoomeANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44*afc2ba1dSToomas SoomeIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45*afc2ba1dSToomas SoomeARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
46*afc2ba1dSToomas SoomeFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47*afc2ba1dSToomas SoomeDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48*afc2ba1dSToomas SoomeOR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49*afc2ba1dSToomas SoomeHOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50*afc2ba1dSToomas SoomeLIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51*afc2ba1dSToomas SoomeOUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52*afc2ba1dSToomas SoomeSUCH DAMAGE.
53