diff --git a/BUILDING.md b/BUILDING.md index 09536e05..aeff8c9d 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -4,7 +4,9 @@ You have the option to ... - either add the plugin to the OBS source tree directly and build the plugin while building OBS itself. (**in tree**) - or you can move the sources of this plugin outside of the OBS source tree and build it separately from OBS. (**out of tree**) -As both methods require you to have a working [OBS Studio development environment](https://obsproject.com/wiki/install-instructions) it is recommended to build the plugin in tree as it is easier to set up. +As both methods require you to have a working [OBS Studio development environment](https://obsproject.com/wiki/install-instructions), [Qt](https://download.qt.io/official_releases/qt/5.15/5.15.2/) and [CMake](https://cmake.org/download/) it is recommended to build the plugin in tree as it is easier to set up and will enable straightforward debugging. + +Note that your Qt install must include the QtConcurrent module. ## Compiling in tree (recommended) Add the "SceneSwitcher" source directory to your obs-studio source directory under obs-studio/UI/frontend-plugins/: diff --git a/README.md b/README.md index d3fc719f..26cbca2a 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,26 @@ An automated scene switcher for OBS Studio More information can be found on https://obsproject.com/forum/resources/automatic-scene-switching.395/. -See https://github.com/WarmUpTill/SceneSwitcher/blob/master/CI/release/README.txt for installing releases. ## Downloads Binaries for Windows, MacOS, and Linux are available in the [Releases](https://github.com/WarmUpTill/SceneSwitcher/releases) section. +## Installing the plugin + +For the Windows and MacOS platforms, it is recommended to run the provided installers. + +For Linux the Snap package manager offers an OBS Studio installation which is bundled with the plugin: +``` +sudo snap install obs-studi +``` + +If that is not an option you will have to ... +1. Copy the library to the plugins folder of you obs installation. +2. Copy the contents of the data directory to its respective folders of your obs installation. + +Unfortunately the exact location of these folders may vary from system to system. + ## Compiling the plugin See the [build instructions](BUILDING.md).