about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorTheofilos Augoustis <theofilos.augoustis@gmail.com>2025-10-02 10:55:06 +0000
committerTheofilos Augoustis <theofilos.augoustis@gmail.com>2025-10-16 10:06:31 +0000
commit67e91988da20e3ab86cc5ae078b32c9d8a81b951 (patch)
tree5586611819c2766fb34e0e95c80caf99c2e29efc
parent41b9c7183eab9470e55bb949a1fc695261786bf1 (diff)
downloadfocaccia-67e91988da20e3ab86cc5ae078b32c9d8a81b951.tar.gz
focaccia-67e91988da20e3ab86cc5ae078b32c9d8a81b951.zip
Update README to include information about running helper tools
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 67db62c..0eb103b 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,18 @@ It will take a while to compile.
 
 ## How To Use
 
-`focaccia.py` is the main executable. Invoke `focaccia.py --help` to see what you can do with it.
+`focaccia` is the main executable. Invoke `focaccia --help` to see what you can do with it.
+
+A number of additional tools are included to simplify use when validating QEMU:
+`capture-transforms`, `convert-log`, `validate-qemu`. They enable the following workflow.
+
+```bash
+capture-transforms -o oracle.trace bug.out
+qemu-x86_64 -g 12345 bug.out &
+validate-qemu --symb-trace oracle.trace localhost 12345
+```
+
+Using this workflow, Focaccia can determine whether a mistranslation occured in that particular QEMU run.
 
 ## Tools