aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..745ed7a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# 🚀 Soyuz
+
+Soyuz has one simple purpose; listen for incoming Discord RPC requests from
+Lunar Client and block them!
+
+<a href="https://github.com/fuwn/soyuz">
+ <img
+ src="https://www.spacesafetymagazine.com/wp-content/uploads/2014/08/early-soyuz-capsule.gif"
+ alt="Soyuz"
+ width="220">
+</a>
+
+## Usage
+
+Prebuilt binaries are located in the
+[releases](https://github.com/Fuwn/soyuz/releases/latest).
+
+### Building from source
+
+```powershell
+mkdir build
+cd .\build\
+cmake ..
+& "C:\Program Files\Microsoft Visual Studio\2022\Community\Msbuild\Current\Bin\MSBuild.exe" .\soyuz.sln /property:Configuration=MinSizeRel -m
+```
+
+## "Startup" Support
+
+1. Create a shortcut to the Soyuz executable
+2. Move the shortcut to
+ `C:\Users\<username>\AppData\Roaming\Microsoft\Windows\StartMenu\Programs\Startup`
+
+## License
+
+[GNU General Public License v3.0](https://github.com/Fuwn/soyuz/blob/main/LICENSE)