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