From cb0a9adebe889ac07696713ba56c436fb0849000 Mon Sep 17 00:00:00 2001
From: Nyaaori <+@nyaaori.cat>
Date: Tue, 28 Nov 2023 08:30:35 +0100
Subject: [PATCH] chore: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4b17bc4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+Extends available steam deck refresh rate options
+
+**Running hardware outside of factory specifications may reduce lifespan and/or cause damage**
+I am not responsible if your Steam Deck dies prematurely or any other damage occurs to it.
+
+Be prepared to restore your Steam Deck using a recovery image if installation goes wrong or other problems arise.
+
+Usage/Installation:
+
+1. Enter desktop mode
+2. Download install-rre.sh
+3. From terminal, run `sudo ./install-rre.sh`
+4. Return to Gaming Mode
+
+
+Ensure that you have Unified Frame Rate / Refresh Rate Limiter enabled
+
+Tested working on SteamOS 3.5.7, other versions may not work
+
+Available Refresh Rates:
+
+LCD Panel Deck: 40-70Hz
+BOE OLED Panel Deck: 40-120Hz [Theoretical Bandwidth Limit is ~133Hz]
+SDC OLED Panel Deck: **Untested** 40-120Hz [**Theoretical Bandwidth Limit is ~100Hz**]
+
+
+If you are at Valve and would like to incorporate part/all of my changes into gamescope/SteamOS, I would appreciate being contacted first.