From 585e9f3b6e0fadd70063127a19bdf33b458206b5 Mon Sep 17 00:00:00 2001 From: Virgil Dupras Date: Sat, 23 Nov 2019 15:22:26 -0500 Subject: [PATCH] tools/emul: add troubleshooting instructions in README fixes #79 --- tools/emul/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/tools/emul/README.md b/tools/emul/README.md index 3b43f52..862da47 100644 --- a/tools/emul/README.md +++ b/tools/emul/README.md @@ -57,3 +57,18 @@ memory starting at address 0 and then run the code until it halts. The exit code of the program is the value of `A` when the program halts. This is used for unit tests. + +## Problems? + +If the libz80-wrapped zasm executable works badly (hangs, spew garbage, etc.), +it's probably because you've broken your bootstrap binaries. They're easy to +mistakenly break. To verify if you've done that, look at your git status. If +`kernel.bin` or `zasm.bin` are modified, try resetting them and then run +`make clean all`. Things should go better afterwards. + +If that doesn't work, there's also the nuclear option of `git reset --hard` +and `git clean -fxd`. + +If that still doesn't work, it might be because the current commit you're on +is broken, but that is rather rare: the repo on Github is plugged on Travis +and it checks that everything is smooth.