From fe30c6ae2cefbe26d97b5b7bf7f18a869b1d7fde Mon Sep 17 00:00:00 2001
From: trivernis <trivernis@protonmail.com>
Date: Sat, 11 Feb 2023 13:52:36 +0100
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a78d40
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# yampad-rs
+
+This is a firmware for the [yampad](https://github.com/mattdibi/yampad) using a rp2040 microcontroller written in rust.
+
+## Install this thing
+
+Put the rp2040 into boot mode by holding the boot button and pressing reset until it shows up as a storage
+device on your computer. 
+After than run 
+```
+  cargo run --release
+```
+to move the firmware to the controller.
+
+That's it.