From e21788cb4084cfdd5291c77788162c6e89df3ca6 Mon Sep 17 00:00:00 2001
From: Laura <paradoor@protonmail.com>
Date: Sun, 24 Mar 2024 23:54:28 +0000
Subject: [PATCH] add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..43fe55e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# disable-c6-runit
+
+A runit service for disabling the C6 power saving state on AMD Zen (Ryzen/Epyc)
+upon boot. The C6 state is known for causing
+[soft lock freezing behaviour](https://wiki.archlinux.org/title/Ryzen#Soft_lock_freezing)
+on Linux.
+
+## Dependencies
+
+* [zenstates.py](https://github.com/r4m0n/ZenStates-Linux) installed in your
+  PATH as `zenstates` (installing `zenstates-git` from the AUR will provide
+  this)
+