collapseos/emul/README.md

35 lines
947 B
Markdown
Raw Normal View History

2019-05-09 12:58:41 -04:00
# emul
2019-05-20 12:11:45 -04:00
This folder contains a couple of tools running under the [libz80][libz80]
emulator.
## Requirements
You need `ncurses` to build the `forth` executable. In debian-based distros,
it's `libncurses5-dev`.
2019-05-20 12:11:45 -04:00
## Build
First, make sure that the `libz80` git submodule is checked out. If not, run
`git submodule init && git submodule update`.
2020-05-03 12:51:21 -04:00
After that, you can run `make` and it builds the `forth` interpreter.
2019-05-20 12:11:45 -04:00
## Usage
2020-06-27 07:53:58 -04:00
The `./forth` executable here works like the one in `/cvm`, except that it runs
under an emulated z80 machine instead of running natively. Refer to
`/cvm/README.md` for details.
2020-06-27 07:53:58 -04:00
## Not real hardware
2020-06-27 07:53:58 -04:00
`./forth` doesn't try to emulate real hardware
because the goal here is to facilitate "high level" development.
2020-06-27 07:53:58 -04:00
These apps run on imaginary hardware and use many cheats to simplify I/Os.
2020-06-27 07:53:58 -04:00
For real hardware emulation (which helps developing drivers), see the `hw`
folder.
2020-05-03 12:51:21 -04:00
[libz80]: https://github.com/ggambetta/libz80