From 180d1b48282bd4dafbeec9f2c358d3e9d794d021 Mon Sep 17 00:00:00 2001
From: kat <116377025+kxtzownsu@users.noreply.github.com>
Date: Wed, 9 Oct 2024 12:47:04 -0400
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cd52170
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# PicoShim
+The smallest shim ever (that boots while still being signed)
+<br>
+# Overview
+PicoShim is a shim made for complete minimalism. 
+
+It is the smallest shim thats able to be made (as of 10/9/24) without modifying the kernel partition
+
+# Build instructions
+Run these commands in a **LINUX** terminal, WSL is not guaranteed to work and will not recieve support.
+```
+git clone https://github.com/kxtzownsu/PicoShim
+cd PicoShim/builder
+sudo bash builder.sh /path/to/raw-shim.bin
+```
+Now flash `/path/to/raw-shim.bin` to a USB and boot it in Developer Mode Recovery (dev=1 reco=1)
+
+# Credits
+kxtzownsu - writing picoshim builder
+
+olyb - shim shrinking code
+
+vk6 - initramfs extraction code