Add more information to the README
This commit is contained in:
11
README.md
11
README.md
@@ -1,5 +1,16 @@
|
|||||||
# Wipforth
|
# Wipforth
|
||||||
|
|
||||||
|
Wipforth is a simple Forth implementation that runs in the WebAssembly
|
||||||
|
virtual machine. It does I/O via memory-mapped peripherals, which are
|
||||||
|
emulated in JavaScript.
|
||||||
|
|
||||||
|
- For the Forth kernel, see [wipforth.wat](./wipforth.wat)
|
||||||
|
- For the JavaScript emulator, see [emu.js](./emu.js)
|
||||||
|
- For the Forth prelude, which is loaded at start-up, see
|
||||||
|
[prelude.f](./prelude.f)
|
||||||
|
- For a description of the peripherals, see the
|
||||||
|
[Peripherals](#peripherals) section below.
|
||||||
|
|
||||||
## Building and Running
|
## Building and Running
|
||||||
|
|
||||||
To run, first compile the WebAssembly module:
|
To run, first compile the WebAssembly module:
|
||||||
|
|||||||
Reference in New Issue
Block a user