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

README update formatting

Browse source 
FossilOrigin-Name: 7a4d3ae787d147ace1e7509b48f2ba8b091b99af96b1e2f5bfe9efba6cbd08a8
This commit is contained in:
crc 2021-12-22 14:20:14 +00:00
parent b63de01059
commit 2ec35cf45c
1 changed files with 30 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README
View file

@ -1,15 +1,28 @@
Retro is a modern, pragmatic Forth drawing influences from many d8888b. d88888b d888888b d8888b. .d88b.
sources. It's clean, elegant, tiny, and easy to grasp and adapt 88 `8D 88' `~~88~~' 88 `8D .8P Y8.
to various uses. 88oobY' 88ooooo 88 88oobY' 88 88
88`8b 88~~~~~ 88 88`8b 88 88
88 `88. 88. 88 88 `88. `8b d8'
88 YD Y88888P YP 88 YD `Y88P'
Features: --------------------------------------------------------------
Retro is a modern, pragmatic Forth drawing influences from
many sources. It's clean, elegant, tiny, easy to grasp, and
adaptable to many tasks.
--------------------------------------------------------------
## Features
- Open Source (ISC License) - Open Source (ISC License)
- Portable (runs on a MISC-style virtual machine) - Portable (runs on a MISC-style virtual machine)
- Small source & binaries - Small source & binaries
- Builds into a single, self contained binary for easy deployment - Builds into a single, self contained binary
- Sources in literate format, using a Markdown variant - Sources in literate format, using a Markdown variant
--------------------------------------------------------------
## Quick Start ## Quick Start
For most systems (FreeBSD, NetBSD, OpenBSD, macOS, Linux): For most systems (FreeBSD, NetBSD, OpenBSD, macOS, Linux):
@ -18,6 +31,8 @@ For most systems (FreeBSD, NetBSD, OpenBSD, macOS, Linux):
You will need a standard C compiler and `make`. You will need a standard C compiler and `make`.
--------------------------------------------------------------
## Executables ## Executables
Binaries will be placed in the `bin` directory. Binaries will be placed in the `bin` directory.
@ -52,6 +67,8 @@ 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.
--------------------------------------------------------------
## Literate Sources ## Literate Sources
Source files for use with `retro` are written with code in Source files for use with `retro` are written with code in
@ -65,11 +82,15 @@ fenced blocks:
Anything outside the fenced blocks will be ignored. 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
epub.) Additional notes can be found in the `doc` directory. epub.) Additional notes can be found in the `doc` 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
@ -78,11 +99,15 @@ 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.
--------------------------------------------------------------
## Learn More ## Learn More
Visit http(s)://retroforth.org to learn more and follow along Visit http(s)://retroforth.org to learn more and follow along
with development. with development.
--------------------------------------------------------------
## Patreon ## Patreon
I have a Patreon at https://www.patreon.com/_crc for those that I have a Patreon at https://www.patreon.com/_crc for those that