add some commentary on building & using retro-compiler

FossilOrigin-Name: a98c6167c4d942aed18c9938210f7102ff7dcb178b22df80ed61fbe145d8a519
This commit is contained in:
crc 2019-02-07 02:08:47 +00:00
parent 56d10523ef
commit 37bc3b8d10

View file

@ -77,6 +77,43 @@ To build:
make bin/retro-barebones
## retro-compiler
This is a turnkey compiler. It can compile a new executable
bundling a Retro VM and image.
Requirements:
- BSD or Linux
- objcopy in $PATH
To build:
make bin/retro-compiler
Example use:
1. Given a source file like "Hello.forth":
~~~
:hello 'hello_world! s:put nl ;
~~~
2. Use:
./bin/retro-compiler Hello.forth hello
The first argument is the source file, the second is the
word to run on startup.
3. Run the generated `a.out`
Limits:
This only supports the core words ('all' interface) and the
file i/o words. Support for other I/O extensions will be
added in the future.
## RETRO12.html
There is a JavaScript and HTML based interface. To