From 948a06cb41438496291070555a3378623a5cee99 Mon Sep 17 00:00:00 2001
From: Virgil Dupras <hsoft@hardcoded.net>
Date: Thu, 12 Dec 2019 16:31:52 -0500
Subject: [PATCH] tools/tests: add missing doc about shell tests

---
 tools/tests/README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/tools/tests/README.md b/tools/tests/README.md
index ec9ae76..1002590 100644
--- a/tools/tests/README.md
+++ b/tools/tests/README.md
@@ -40,3 +40,10 @@ However, there are tricks.
 1. Run `unit/runtests.sh <name of file to test>` to target a specific test unit.
 2. Insert a `halt` to see the value of `A` at any given moment: it will be your
    reported error code (if 0, runbin will report a success).
+
+## shell
+
+Those tests are in the form of shell "replay" files. Every ".replay" file in
+this folder contains the contents to type in the shell. That contents is piped
+through the shell and the output is then compared with the corresponding
+".expected" file. If they match exactly, the test passes.