From fcd0ef3c66fb0b111a335348bb3658986cf96c51 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Tue, 26 Apr 2022 23:41:17 +0000 Subject: docs(readme): update readme --- README.md | 35 +++++++++++++++++++++++++++++++++++ README.rst | 39 --------------------------------------- 2 files changed, 35 insertions(+), 39 deletions(-) create mode 100644 README.md delete mode 100644 README.rst 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! + + + Soyuz + + +## 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\\AppData\Roaming\Microsoft\Windows\StartMenu\Programs\Startup` + +## License + +[GNU General Public License v3.0](https://github.com/Fuwn/soyuz/blob/main/LICENSE) diff --git a/README.rst b/README.rst deleted file mode 100644 index 7c8c3d5..0000000 --- a/README.rst +++ /dev/null @@ -1,39 +0,0 @@ -🚀 Soyuz -======= - -Soyuz has one simple purpose; listen for incoming Discord RPC requests from -Lunar Client and block them! - -.. raw:: html - - - Soyuz - - -Limitations ------------ - -- Windows only - -Soon to come ------------- - -- "Startup" support - -Temporary "Startup" Support Workaround -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1. Create a shortcut for the Soyuz executable -2. Move the shortcut to - - :code:`C:\Users\\AppData\Roaming\Microsoft\Windows\StartMenu\Programs\Startup` - - (replace :code:`` with your Windows user account's username) - -License -------- - -`GNU General Public License v3.0 <./LICENSE>`_ -- cgit v1.2.3