From 2161bcfaa3f10867a1d17b6060fbf5468536d5b6 Mon Sep 17 00:00:00 2001
From: Martijn de Vos <mdmartijndevos@gmail.com>
Date: Wed, 8 Nov 2023 20:18:42 +0100
Subject: [PATCH] Added README.md

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..092da85
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+### Generating an iPod Touch 2G NAND Image (for QEMU-iOS)
+
+This README contains the instructions on how to generate the NAND image for the iPod Touch 2G that can be read by [QEMU-iOS](https://github.com/devos50/qemu-ios).
+For this, you must put the `filesystem-it2g-readonly.img` file of the filesystem that will be included in the NAND image in the root of this repository.
+
+First, compile the binary with the following command:
+
+```
+gcc generate_nand.c -o generate_nand
+```
+
+Before generating the NAND image, make sure to remove any prior NAND data by running `rm -rf nand`.
+Then, generate your NAND image by running the compiled binary:
+
+```
+./generate_nand
+```