From edfa6a89861904f83763464f3a01f8f8a9a9a684 Mon Sep 17 00:00:00 2001
From: momo5502 <mauriceheumann@gmail.com>
Date: Tue, 31 Dec 2024 08:42:11 +0100
Subject: [PATCH] Document registry dumping

Relevant for #37
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 508c4f4b..87f8f572 100644
--- a/README.md
+++ b/README.md
@@ -83,6 +83,12 @@ Release build:
 cmake --workflow --preset=release
 ```
 
+## Dumping the Registry
+
+The emulator needs a registry dump to run, otherwise it will print `Bad hive file` errors.  
+You can create one by running the <a href="./src/grab-registry.bat">src/grab-registry.bat</a> script as administrator.  
+This will create a `registry` folder that needs to be placed in the working directory of the emulator.
+
 ## Running Tests
 
 The project uses CTest for testing. Choose your preferred method: