about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 63428b0..4200b8c 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,19 @@ PYTHONPATH="$PYTHONPATH:$(./build/bin/lldb -P)"
 
 It will take a while to compile.
 
-## Snapshot-comparison framework
+## How To Use
+
+`focaccia.py` is the main executable. Invoke `focaccia.py --help` to see what you can do with it.
+
+## Tools
+
+The `tools/` directory contains additional utility scripts to work with focaccia.
+
+ - `convert.py`: Convert logs from QEMU or Arancini to focaccia's snapshot log format.
+
+## Project Overview (for developers)
+
+### Snapshot-comparison framework
 
 The following files belong to a rough framework for the snapshot comparison engine: