Refresh documents (README.md and our site) (#676)

Author: umireon

README.md

@@ -2,34 +2,31 @@
 
 <div align="center">
 
-[![GitHub](https://img.shields.io/github/license/locaal-ai/obs-backgroundremoval)](https://github.com/locaal-ai/obs-backgroundremoval/blob/main/LICENSE)
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/locaal-ai/obs-backgroundremoval/push.yaml)](https://github.com/locaal-ai/obs-backgroundremoval/actions/workflows/push.yaml)
-[![Total downloads](https://img.shields.io/github/downloads/locaal-ai/obs-backgroundremoval/total)](https://github.com/locaal-ai/obs-backgroundremoval/releases)
+[![GitHub](https://img.shields.io/github/license/royshil/obs-backgroundremoval)](https://github.com/royshil/obs-backgroundremoval/blob/main/LICENSE)
+[![GitHub Workflow Status](https://github.com/royshil/obs-backgroundremoval/actions/workflows/push.yaml/badge.svg)](https://github.com/royshil/obs-backgroundremoval/actions/workflows/push.yaml)
+[![Total downloads](https://img.shields.io/github/downloads/royshil/obs-backgroundremoval/total)](https://github.com/royshil/obs-backgroundremoval/releases)
 ![Flathub](https://img.shields.io/flathub/downloads/com.obsproject.Studio.Plugin.BackgroundRemoval?label=Flathub%20Installs)
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/locaal-ai/obs-backgroundremoval)](https://github.com/locaal-ai/obs-backgroundremoval/releases)
-[![Discord](https://img.shields.io/discord/1200229425141252116)](https://discord.gg/KbjGU2vvUz)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/royshil/obs-backgroundremoval)](https://github.com/royshil/obs-backgroundremoval/releases)
 
 </div>
 
 A plugin for [OBS Studio](https://obsproject.com/) that allows you to replace the background in portrait images and video, as well as enhance low-light scenes.
 
-- [Usage](#usage)
-- [Download](#download)
-- [Introduction](#introduction)
-- [Building](#building)
-  - [MacOSX](#mac-osx)
-  - [Linux (Ubuntu, Arch, openSUSE, Fedora)](#linux)
-  - [Windows](#windows)
+<p align="center">
+  <a href="https://royshil.github.io/obs-backgroundremoval/">
+    <b>⬇️ Download & Install OBS Background Removal ⬇️</b>
+  </a>
+</p>
 
-For other AI plugins from us check out [locaal AI](https://github.com/locaal-ai).
+Or, browse versions on [releases page](https://github.com/royshil/obs-backgroundremoval/releases).
 
 ## Usage
 
-<div align="center">
+<div style="text-align:center;">
 <video src="https://github.com/locaal-ai/obs-backgroundremoval/assets/1067855/5ba5aae2-7ea2-4c90-ad45-fba5ccde1a4e" width="320"></video>
 </div>
 
-Check out the [usage guide page](https://locaal-ai.github.io/obs-backgroundremoval/usage) for usage walkthrough and recommendations.
+Check out the [usage guide page](https://royshil.github.io/obs-backgroundremoval/usage/) for usage walkthrough and recommendations.
 
 Additional tutorial videos:
 
@@ -38,41 +35,6 @@ Additional tutorial videos:
 - Low-light enhancement: https://youtu.be/WSBLYWFrn2Q
 - Remove background from ANY object (not just human): https://youtu.be/N74VCDCToX8
 
-## Download
-
-Check out the [guide page](https://royshil.github.io/obs-backgroundremoval/) for downloads and install instructions for **Windows** and **MacOS**.
-
-### Linux Installation
-
-On Ubuntu, there are two ways to install OBS and you have to use the corresponding method to install this plugin.
-
-- If you installed OBS via the official PPA, download the deb package from the [releases](https://github.com/locaal-ai/obs-backgroundremoval/releases) page and install it directly.
-- If you installed OBS via FlatHub, run the following command: `flatpak install com.obsproject.Studio.Plugin.BackgroundRemoval`
-
-The pre-built binary of this plugin can run Ubuntu 22.04 or later.
-
-On openSUSE, please see [`docs/BUILDING-OPENSUSE.md`](docs/BUILDING-OPENSUSE.md).
-
-#### FlatHub
-
-On Debian, you cannot use our deb package and we only support FlatHub installation.
-
-On other Linux distros, use the FlatHub installation of both OBS and this plugin.
-
-```
-flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
-flatpak install flathub com.obsproject.Studio
-flatpak install flathub com.obsproject.Studio.Plugin.BackgroundRemoval
-```
-
-If you install OBS in a way other than FlatHub, you have to build this plugin by yourself (see instructions for building [below](#linux)).
-
-### OBS Version Support and Compatibility
-
-- OBS version 29+ ([download](https://obsproject.com/download)) for the latest version of this plugin, e.g. 1.1.x and above.
-- OBS version 28+ for this plugin's version between 0.5.x and 1.0.x.
-- OBS version 27+ for this plugin's version 0.4.x and below.
-
 ## Introduction
 
 This plugin is meant to make it easy to replace the background in portrait images and video.
@@ -87,20 +49,22 @@ If you like this work, which is given to you completely free of charge, please c
 
 ### Support and Help
 
-Reach out to us on [Discord](https://discord.gg/3EUBUjpCD3) or the [OBS Plugins forum](https://obsproject.com/forum/resources/background-removal-portrait-segmentation.1260/) for online / immediate help.
+Reach out to us on [GitHub Discussions](https://github.com/royshil/obs-backgroundremoval/discussions) or the [OBS Plugins forum](https://obsproject.com/forum/resources/background-removal-portrait-segmentation.1260/) for online / immediate help.
 
-If you found a bug or want to suggest a feature or improvement please open an [issue](https://github.com/locaal-ai/obs-backgroundremoval/issues).
+If you found a bug or want to suggest a feature or improvement please open an [issue](https://github.com/royshil/obs-backgroundremoval/issues).
 
 If you are looking for hands-on help or private consultation please select a [sponsorship tier](https://github.com/sponsors/royshil?frequency=one-time).
 
 ### Technical Details
 
+<!--
 GPU support:
 
 - Currently on Windows we support DirectML, which should reduce CPU usage by 95% and effectively use the systems accelerators (GPUs if available).
 - On Mac we support CoreML for acceleration, which is available on M1 and M2 (not Intel, sorry).
 - CUDA is supported in this plugin through TensorRT, however it is supported only on Linux.
 - The goal of this plugin is to be available for everyone on every system, even if they don't own a GPU.
+-->
 
 Number of CPU threads is controllable through the UI settings. A 2-thread setting works best.
 
@@ -132,70 +96,6 @@ This video on YouTube will take you through the major parts of the code and expl
   </a>
 </div>
 
-## Building
-
-The plugin was built and tested on Mac OSX (Intel & Apple silicon), Windows and several Linux disros (e.g. Ubuntu/Debian-ish, Fedora, and more). Help is appreciated in building on other OSs and packages.
-
-The building pipelines in CI take care of the heavy lifting. Use them in order to build the plugin locally. We attempt to use external OpenCV, libcurl and ONNX Runtime to reduce build times.
-
-Start by cloning this repo to a directory of your choice.
-
-### Mac OSX
-
-Using the CI pipeline scripts, locally you would just call the zsh script. By default this builds a universal binary for both Intel and Apple Silicon. To build for a specific architecture please see `.github/scripts/.build.zsh` for the `-arch` options.
-
-```sh
-$ ./.github/scripts/build-macos -c Release
-```
-
-#### Install
-
-The above script should succeed and the plugin files (e.g. `obs-backgroundremoval.plugin`) will reside in the `./release/Release` folder off of the root. Copy the `.plugin` file to the OBS directory e.g. `~/Library/Application Support/obs-studio/plugins`.
-
-To get `.pkg` installer file, run for example
-
-```sh
-$ ./.github/scripts/package-macos -c Release
-```
-
-(Note that maybe the outputs will be in the `Release` folder and not the `install` folder like `pakage-macos` expects, so you will need to rename the folder from `build_x86_64/Release` to `build_x86_64/install`)
-
-### Linux
-
-#### Ubuntu
-
-Use the CI scripts again
-
-```sh
-$ ./.github/scripts/build-linux.sh
-```
-
-#### Arch Linux
-
-The community maintains AUR packages: https://aur.archlinux.org/packages/obs-backgroundremoval
-
-#### Fedora
-
-To compile on Fedora, you need to manage the dependencies manually. See [docs/BUILDING-FEDORA.md](docs/BUILDING-FEDORA.md) for more information.
-
-#### FlatHub
-
-The plugin is available on FlatHub: https://github.com/flathub/com.obsproject.Studio.Plugin.BackgroundRemoval
-
-```sh
-$ flatpak install com.obsproject.Studio.Plugin.BackgroundRemoval
-```
-
-### Windows
-
-Use the CI scripts again, for example:
-
-```powershell
-> .github/scripts/Build-Windows.ps1 -Target x64 -CMakeGenerator "Visual Studio 17 2022"
-```
-
-The build should exist in the `./release` folder off the root. You can manually install the files in the OBS directory.
-
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=locaal-ai/obs-backgroundremoval&type=Date&theme=dark" />
   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=locaal-ai/obs-backgroundremoval&type=Date" />

docs/UNINSTALL.md

@@ -47,6 +47,28 @@ const { BASE_URL } = import.meta.env;
     --color-bg-0: rgb(202, 216, 228);
     --color-bg-1: hsl(209, 36%, 86%);
     --color-bg-2: hsl(224, 44%, 95%);
+    --color-button-1: #007acc;
+    --color-button-2: #189cff;
+    --color-white-box-bg: #fbfbfb;
+    --color-box-shadow: #0000001a;
+  }
+
+  main.white-box {
+    max-width: 800px;
+    width: 100%;
+    margin: 1rem auto;
+    padding: 2rem;
+    box-sizing: border-box;
+    overflow: visible;
+
+    border-radius: 8px;
+    box-shadow: 0 4px 8px var(--color-box-shadow);
+
+    background-color: var(--color-white-box-bg);
+  }
+
+  .astro-code {
+    padding: 10px;
   }
 </style>
 
@@ -60,17 +82,11 @@ const { BASE_URL } = import.meta.env;
 
   html {
     background-attachment: fixed;
-    background-image:
-      radial-gradient(
-        50% 50% at 50% 50%,
-        rgba(255, 255, 255, 0.75) 0%,
-        rgba(255, 255, 255, 0) 100%
-      ),
-      linear-gradient(
-        180deg,
-        var(--color-bg-0) 0%,
-        var(--color-bg-1) 15%,
-        var(--color-bg-2) 50%
-      );
+    background-image: linear-gradient(
+      180deg,
+      var(--color-bg-0) 0%,
+      var(--color-bg-1) 15%,
+      var(--color-bg-2) 50%
+    );
   }
 </style>

pages/src/assets/checkDll.png

@@ -0,0 +1,24 @@
+---
+import { joinURL } from "ufo";
+
+import Layout from './Layout.astro';
+
+interface Props {
+  frontmatter: {
+    lang: string;
+    title: string;
+    description: string;
+  };
+}
+
+const { BASE_URL } = import.meta.env;
+const { lang, title, description } = Astro.props.frontmatter;
+---
+
+<Layout lang={lang} title={title} description={description}>
+  <main class="white-box">
+    <slot />
+
+    <p><a href={joinURL(BASE_URL, "/")}>Back to the top page</a></p>
+  </main>
+</Layout>