crc/retroforth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updates to the README, add Bartels Jon Randy to Patreons

Browse source 
FossilOrigin-Name: 767b9ea9d78e5d44884a1b5729dcdcbd7cabbfe9ec859e653c4f79c05256d997
This commit is contained in:
crc 2021-04-22 19:38:36 +00:00
parent f0257387d4
commit 191e64e5e2
1 changed files with 10 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README
View file

@ -1,5 +1,3 @@
## Retro: A Modern, Pragmatic Forth
RETRO is a modern, pragmatic Forth drawing influences from many RETRO is a modern, pragmatic Forth drawing influences from many
sources. It's clean, elegant, tiny, and easy to grasp and adapt sources. It's clean, elegant, tiny, and easy to grasp and adapt
to various uses. to various uses.
@ -32,13 +30,14 @@ The `retro` executable embeds the image into the binary, making
it trivial to copy and deploy. it trivial to copy and deploy.
This interface layer also extends the language with many new This interface layer also extends the language with many new
words and vocabularies, adds scripting, file i/o, gopher, and words and vocabularies, adds scripting, file i/o, floating point,
floating point math support. and more.
The `retro` executable can handle a variety of command line The `retro` executable can handle a variety of command line
arguments: arguments which are covered in the manpage, but the most common
ones are:
retro -i retro
Starts the *listener*, a basic REPL for interactive use. Starts the *listener*, a basic REPL for interactive use.
@ -53,15 +52,13 @@ header line like `#!/usr/bin/env retro`.
This will run the code in the specified file, then start the This will run the code in the specified file, then start the
listener. listener.
retro -h ## Literate Sources
Displays a summary of the command line arguments.
Source files for use with `retro` are written with code in Source files for use with `retro` are written with code in
fenced blocks: fenced blocks:
commentary here commentary here
~~~ ~~~
code here code here
~~~ ~~~
@ -71,13 +68,12 @@ Anything outside the fenced blocks will be ignored.
## Documentation ## Documentation
The primary documentation is in RETRO-Book.md (and the formatted The primary documentation is in RETRO-Book.md (and the formatted
RETRO-Book.html.) Additional notes can be found in the `doc` epub.) Additional notes can be found in the `doc` directory.
directory.
## Alternative Implementations ## Alternative Implementations
In addition to the C and Python implementations, this source In addition to the C and Python implementations, this source
tree includes additional implementations in C#, JavaScript, tree includes additional implementations in C#, Nim, JavaScript,
and Pascal. These are not as well tested or as feature complete and Pascal. These are not as well tested or as feature complete
as the main implementations, but are provided for your use if as the main implementations, but are provided for your use if
the standard implementations will not suffice. the standard implementations will not suffice.
@ -95,3 +91,4 @@ Thanks go out to my current and past patrons:
- Krinkleneck - Krinkleneck
- Rick Carlino - Rick Carlino
- Scott McCallum - Scott McCallum
- Bartels Jon Randy