about summary refs log tree commit diff stats
path: root/examples/Readme.md
diff options
context:
space:
mode:
authorKartik Agaram <vc@akkartik.com>2019-07-27 16:01:55 -0700
committerKartik Agaram <vc@akkartik.com>2019-07-27 17:47:59 -0700
commit6e1eeeebfb453fa7c871869c19375ce60fbd7413 (patch)
tree539c4a3fdf1756ae79770d5c4aaf6366f1d1525e /examples/Readme.md
parent8846a7f85cc04b77b2fe8a67b6d317723437b00c (diff)
downloadmu-6e1eeeebfb453fa7c871869c19375ce60fbd7413.tar.gz
5485 - promote SubX to top-level
Diffstat (limited to 'examples/Readme.md')
-rw-r--r--examples/Readme.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/examples/Readme.md b/examples/Readme.md
new file mode 100644
index 00000000..d4bb1ff5
--- /dev/null
+++ b/examples/Readme.md
@@ -0,0 +1,6 @@
+Small example programs, each with a simple pedagogical goal.
+
+They also help to validate SubX instruction semantics against native x86
+hardware. For example, loading a single byte to a register would for some time
+clear the rest of the register. This behavior was internally consistent with
+unit tests. It took running an example binary natively to catch the discrepancy.