crc/retroforth: Retro is a modern, pragmatic Forth drawing influences from many sources. It's clean, elegant, small, easy to grasp, and adaptable to many tasks.

Retro is a modern, pragmatic Forth drawing influences from many sources. It's clean, elegant, small, easy to grasp, and adaptable to many tasks.

Find a file

crc 752a312f88 casket: dont require specifying the index.html for directories FossilOrigin-Name: d6cf6ded09795da5e31872bd9cbb6fe01d2078e436202d8a94988668384cdb20		2021-06-09 12:16:02 +00:00
.builds	automated testing: fix some things related to testing retro-compiler	2021-05-18 14:09:10 +00:00
benchmarks	benchmarks: add a simple `choose` benchmark (#26 )	2020-12-18 20:18:13 +00:00
doc	image: rename s:index-of, s:index-of-string, a:index-of, a:index-of-string	2021-06-04 18:34:59 +00:00
example	casket: dont require specifying the index.html for directories	2021-06-09 12:16:02 +00:00
image	image: rename s:index-of, s:index-of-string, a:index-of, a:index-of-string	2021-06-04 18:34:59 +00:00
interface	nga-c: fix an issue with script:current-line	2021-06-03 14:07:29 +00:00
man	nga-c: -t now takes a command line argument for the file name	2021-06-01 13:42:30 +00:00
package	image: rename s:index-of, s:index-of-string, a:index-of, a:index-of-string	2021-06-04 18:34:59 +00:00
rel/python	run black to reformat Python files	2021-01-20 17:41:34 +00:00
security	add additional public keys for future releases	2021-05-17 14:08:30 +00:00
tests	add test images for each instruction excluding i/o	2021-06-01 19:00:48 +00:00
tools	image: rename some words	2021-06-04 13:54:21 +00:00
vm	nga-c: fix bug in ha instruction	2021-06-09 00:09:05 +00:00
.gitattributes	github: add file type overrides for linguist	2021-01-27 13:40:59 +00:00
GNUmakefile	gnu make: for retro-compiler, enable NEEDS_STRL and i/o devices	2021-05-18 13:23:26 +00:00
LICENSE	fix typo in LICENSE	2021-01-20 17:41:29 +00:00
Makefile	work on the retro-compiler	2021-05-18 12:42:15 +00:00
Makefile.python	nga-python: add Makefile.python target to package, upload for pypi (#23 )	2021-01-18 15:43:33 +00:00
ngaImage	image: rename s:index-of, s:index-of-string, a:index-of, a:index-of-string	2021-06-04 18:34:59 +00:00
README	begin working on making terminology around the Retro naming consistent	2021-05-12 13:57:22 +00:00
RELEASE-NOTES	image: rename s:index-of, s:index-of-string, a:index-of, a:index-of-string	2021-06-04 18:34:59 +00:00
retroforth.el	add retroforth.el emacs mode	2021-03-30 20:41:40 +00:00

README

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 most systems (FreeBSD, NetBSD, OpenBSD, macOS, Linux):

    make

You will need a standard C compiler and `make`.

## Executables

Binaries will be placed in the `bin` directory.

The primary executable is `retro`. This is used for running the
examples and the Atua (gopher) & Casket (http) servers that
power forthworks.com.

The `retro` executable embeds the image into the binary, making
it trivial to copy and deploy.

This interface layer also extends the language with many new
words and vocabularies, adds scripting, file i/o, floating point,
and more.

The `retro` executable can handle a variety of command line
arguments which are covered in the manpage, but the most common
ones are:

    retro

Starts the *listener*, a basic REPL for interactive use.

    retro filename

This will run the code in the specified file, then exit. This
is also used to run programs as shell-type scripts using a
header line like `#!/usr/bin/env retro`.

    retro -i -f filename

This will run the code in the specified file, then start the
listener.

## Literate Sources

Source files for use with `retro` are written with code in
fenced blocks:

    commentary here

    ~~~
    code here
    ~~~

Anything outside the fenced blocks will be ignored.

## Documentation

The primary documentation is in RETRO-Book.md (and the formatted
epub.) Additional notes can be found in the `doc` directory.

## Alternative Implementations

In addition to the C and Python implementations, this source
tree includes additional implementations in C#, Nim, JavaScript,
and Pascal. These are not as well tested or as feature complete
as the main implementations, but are provided for your use if
the standard implementations will not suffice.

## Patreon

I have a Patreon at https://www.patreon.com/_crc for those that
want to financially support development. All funds raised via
Pateron are put into development related expenses (server expenses,
app store fees, hardware).

Thanks go out to my current and past patrons:

- Kiyoshi YONEDA
- Krinkleneck
- Rick Carlino
- Scott McCallum
- Bartels Jon Randy