retroforth/README.md
crc 230de0d24d some work on documentation expansion/formatting
FossilOrigin-Name: f67d8b36e0945a4fb53a9ed1b0560a09eb4a79791d4411f9b26d60eebee93519
2018-05-10 00:54:05 +00:00

88 lines
2.5 KiB
Markdown

## RETRO FORTH
RETRO is a modern, pragmatic Forth drawing influences from many
sources. It's clean, elegant, tiny, and easy to grasp and adapt
to various uses.
Features:
- Open Source (ISC License)
- Portable (runs on a MISC-style virtual machine)
- Small source & binaries
- Builds into a single, self contained binary for easy deployment
- Sources in literate format, using a Markdown variant
## Quick Start
For FreeBSD, NetBSD, macOS, Linux:
make
You will need a standard C compiler and `make`. The `ri` binary
requires (n)curses, but you can ignore any build/link errors by
doing:
make -kis
## Executables
Binaries will be placed in the `bin` directory.
### rre
Short for `run retro and exit`, this is the primary interface
for RETRO. The `rre` interface is used to run the examples and
Atua Gopher and HTTP servers that power forthworks.com.
`rre` embeds the RETRO image into the binary, making it trivial
to copy and deploy.
The `rre` interface also extends the language with many new
words and vocabularies, adding scripting, file i/o, gopher, and
floating point math support.
### repl
This is a basic `read-evaluate-print-loop` for interactive use.
It's intended for quick tests and as an easy starting point for
new interfaces.
The `repl` interface looks for the RETRO image (`ngaImage`) in
the current working. If not found, this will use an embedded
copy.
### ri
`ri` is an interactive, (n)curses based interface inspired by
the interface used around 2001 with RETRO4. It provides an
output area and then an input area at the bottom. Input is
processed as it is entered, and the top stack items appear to
the right of the input.
It's useful for playing around with new ideas and seeing how
the stack works.
## Commercial Versions
I provide proprietary versions of RETRO for iOS and macOS.
These use a custom, dual pane editor-based environment and
some platform specific words and extensions. They do use the
same image and virtual machine as `rre`, `repl`, etc.
iOS: https://itunes.apple.com/us/app/retro-forth-12/id1170943580?ls=1&mt=8
macOS: https://itunes.apple.com/us/app/retro-forth/id1317494014?ls=1&mt=12
The macOS application is also availble for free, though the
source is not published.
Proceeds from these are used to pay for various project related
expenses (vps, domains, hardware upgrades, and an occasional
cup of tea).
## Alternative Implementations
This source tree includes implementations in C#, JavaScript,
Pascal, and Python. These are not officially supported, but
are provided for your use if the C implementation will not
suffice.