diff options
| author | Fuwn <[email protected]> | 2022-04-26 23:41:17 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2022-04-26 23:41:17 -0700 |
| commit | d760929877e2ee0be7755a32f2c674ca0bd4be14 (patch) | |
| tree | 635187bd78d1d8b420e3f3e75608457005d80394 | |
| parent | build(cmake): cleanup cmake.toml (diff) | |
| download | soyuz-d760929877e2ee0be7755a32f2c674ca0bd4be14.tar.xz soyuz-d760929877e2ee0be7755a32f2c674ca0bd4be14.zip | |
docs(readme): update readme
| -rw-r--r-- | README.md | 35 | ||||
| -rw-r--r-- | README.rst | 39 |
2 files changed, 35 insertions, 39 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) 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 - - <a href="https://github.com/fuwn/soyuz"> - <img - src="http://www.spacesafetymagazine.com/wp-content/uploads/2014/08/early-soyuz-capsule.gif" - alt="Soyuz" - width="220"> - </a> - -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\<username>\AppData\Roaming\Microsoft\Windows\StartMenu\Programs\Startup` - - (replace :code:`<username>` with your Windows user account's username) - -License -------- - -`GNU General Public License v3.0 <./LICENSE>`_ |