Add README

Signed-off-by: Park Ju Hyung <[email protected]>

Author: arter97

README.md

@@ -0,0 +1,25 @@
+# SimpleMSR
+SimpleMSR is an extremely simple kernel extension for macOS, writing MSR values.
+This can be used for undervolting or disabling BD PROCHOT.
+
+This project was made to avoid using complicated voltage controlling interfaces
+and sleep/resume watcher.
+
+SimpleMSR uses native macOS PM callbacks to restore MSR values without any timer
+overheads which could be found with conventional sleep/resume watchers.
+
+## Before using it
+One negative is that SimpleMSR doesn't support dynamic user controls.
+(This could also be seen as a positive since no possible overheads are introduced.)
+
+You must hardcode MSR values you'd like to use at the time of compilation.
+Be extremely cautious using a prebuit version of SimpleMSR.
+
+Open up SimpleMSR/SimpleMSR.hpp to customize MSR values.
+And for undervolting, you can consult https://github.com/mihic/linux-intel-undervolt.
+
+## Usage
+After build is done, you can install this to Clover's kexts directory.
+
+If you want to install this natively, you must disable SIP(rootless=0) and
+code-sign it yourself.