From b5c4c274630bb7cac5191868e8966970fcc39186 Mon Sep 17 00:00:00 2001 From: Michael Fabian 'Xaymar' Dirks Date: Wed, 4 Oct 2023 07:27:17 +0200 Subject: [PATCH] Switch to AsciiDoc --- README.ad | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 14 -------------- 2 files changed, 57 insertions(+), 14 deletions(-) create mode 100644 README.ad delete mode 100644 README.md diff --git a/README.ad b/README.ad new file mode 100644 index 00000000..4aa57048 --- /dev/null +++ b/README.ad @@ -0,0 +1,57 @@ +== image:https://raw.githubusercontent.com/Xaymar/obs-StreamFX/master/media/logo.png[alt="StreamFX"] +Upgrade your setup with several modern sources, filters, transitions and encoders using StreamFX! With several performant and flexible features, you will discover new ways to build your scenes, better ways to encode your content, and take your stream to the next level. Create cool new scenes with 3D effects, add glow or shadow, or blur out content - endless choices, and all of it at your fingertips. + +++++ +

+ +More Information
+CI Status +Crowdin Status + +

+++++ + +=== Support the development of StreamFX! +++++ + +Patreon + +++++ +Maintaining a project like StreamFX requires time and money, of which both are in short supply. If you use any feature of StreamFX, please consider supporting StreamFX via link:https://patreon.com/xaymar[Patreon]. Even as little as 1€ per month matters a lot, plus you get a number of benefits! + +=== License +Licensed under link:https://github.com/Xaymar/obs-StreamFX/blob/root/LICENSE[GPLv3 (or later), see LICENSE]. Additional works included are: + +[options="header"] +|================= +|Work |License |Author(s) + +|link:https://gen.glad.sh/[GLAD] +|link:https://github.com/Dav1dde/glad/blob/glad2/LICENSE[MIT License] +|link:https://github.com/Dav1dde/glad/graphs/contributors?type=a[Dav1dde, madebr, BtbN, and more] + +|link:https://github.com/nlohmann/json[JSON for Modern C++] +|link:https://github.com/nlohmann/json/blob/develop/LICENSE.MIT[MIT License] +|link:https://github.com/nlohmann/json/graphs/contributors?type=a[nlohmann, ChrisKtiching, nickaein, and more] + +|link:https://github.com/NVIDIA/MAXINE-AFX-SDK[NVIDIA Maxine Audio Effects SDK] +|link:https://github.com/NVIDIA/MAXINE-AFX-SDK/blob/master/LICENSE[MIT License] +|link:https://nvidia.com/[NVIDIA Corporation] + +|link:https://github.com/NVIDIA/MAXINE-AR-SDK[NVIDIA Maxine Augmented Reality SDK] +|link:https://github.com/NVIDIA/MAXINE-Ar-SDK/blob/master/LICENSE[MIT License] +|link:https://nvidia.com/[NVIDIA Corporation] + +|link:https://github.com/NVIDIA/MAXINE-VFX-SDK[NVIDIA Maxine Video Effects SDK] +|link:https://github.com/NVIDIA/MAXINE-VFX-SDK/blob/master/LICENSE[MIT License] +|link:https://nvidia.com/[NVIDIA Corporation] + +|link:https://github.com/obsproject/obs-studio[Open Broadcaster Software Studio] +|link:https://github.com/obsproject/obs-studio/blob/master/COPYING[GPL-2.0 (or later)] +|link:https://github.com/obsproject/obs-studio/graphs/contributors?type=a[jp9000, computerquip, and more] + +|link:https://www.qt.io/[Qt 6.x] +|link:https://www.qt.io/download-open-source[(L)GPL-3.0 (or later)] +|link:https://www.qt.io/[The Qt Company], and open source contributors + +|================= diff --git a/README.md b/README.md deleted file mode 100644 index 98a3d2b7..00000000 --- a/README.md +++ /dev/null @@ -1,14 +0,0 @@ -![StreamFX Logo](https://raw.githubusercontent.com/Xaymar/obs-StreamFX/master/media/logo.png) -# StreamFX -Bring your setup to the modern day with StreamFX! With several super fast filters, new ways to build your scenes, and new encoders you can now take your stream even further. Create cool new scenes with 3D effects, make something glow or have a shadow, or blur out content - the choice is yours! - -[![CI](https://github.com/Xaymar/obs-StreamFX/actions/workflows/main.yml/badge.svg)](https://github.com/Xaymar/obs-StreamFX/actions) [![Crowdin](https://badges.crowdin.net/obs-stream-effects/localized.svg)](https://crowdin.com/project/obs-stream-effects) - -# Support the development of StreamFX! -[Patreon](https://patreon.com/join/xaymar) Maintaining a project like StreamFX requires time and money, of which both are in short supply. If you use any feature of StreamFX, please consider supporting StreamFX via [Patreon](https://patreon.com/xaymar). Even as little as 1€ per month matters a lot, plus you get a number of benefits! - -## Further Links -* [Wiki](https://github.com/Xaymar/obs-StreamFX/wiki) -* [Installation Guide](https://github.com/xaymar/obs-streamfx/wiki/Installation) -* See BUILDING.md -* See CONTRIBUTING.md