commit c504f446ee8e6bc57a5ab893d442089404576eae
parent 650453d358dd4ba319352b3d61b4b7c3850933d0
Author: Luxferre <lux@ferre>
Date: Thu, 11 May 2023 18:40:08 +0300
fixed wrapper a bit
Diffstat:
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# DALE-8A: A CHIP-8 platform emulator for POSIX AWK
+# DALE-8A: a CHIP-8 platform emulator for POSIX AWK
This is an advanced port of my previous JS-based CHIP-8 emulator, [DALE-8](https://gitlab.com/suborg/dale-8/), to the AWK programming language in its standard (POSIX) variation. The port was also inspired by [awk-chip8 by patsie75](https://github.com/patsie75/awk-chip8) although not a single piece of code is used from there as that emulator heavily depends on GAWK-specific features and doesn't emulate certain ROM quirks. Compared to the original DALE-8, DALE-8A drops the sound output capability but implements everything else using CLI pseudographics and also is fully compatible with low-res CHIP-8 ROMs developed using the [Octo](https://johnearnest.github.io/Octo/index.html) IDE. All the required interactive input and binary loading functions are provided by my own POSIX-compatible library, `tgl.awk` (The Great Library). As such, DALE-8A externally depends on the `stty` and `od` commands only.
@@ -40,6 +40,8 @@ LANG=C awk -f tgl.awk -f dale8a.awk [params] -- prog.ch8
If the ROM file has `.l.ch8` extension, additional `LSQ` emulation quirk will be applied (see below). If the file has `.s.ch8` extention, additional `STQ` emulation quirk will be applied (see below). Is the file has `.sl.ch8` or `.ls.ch8` extension, both quirks will be applied.
+The wrapper script tries to use the default `awk` command found on your system. You can also modify the `AWKENGINE` variable assignment or uncomment one of the predefined options below. To achieve better performance, `mawk -W posix` is recommended if available.
+
### Configuration variables
The DALE-8A script allows to pass a number of configuration variables to the engine using the standard `-v` option of AWK:
