From a48a32931ab9c27663ee13508cb94e5ab67b4646 Mon Sep 17 00:00:00 2001 From: Michael Fabian 'Xaymar' Dirks Date: Sat, 30 Sep 2023 01:54:48 +0200 Subject: [PATCH] Update build guide with latest instructiosn --- BUILDING.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 72bdf009..a0c47301 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -8,14 +8,12 @@ This document intends to guide you through the process of building StreamFX. It 2. Follow the [OBS Studio build guide](https://obsproject.com/wiki/install-instructions) for automated building on your platform of choice. - **MacOS:** You will need to use the XCode generator to build StreamFX as the Ninja generator does not support the flags StreamFX requires. 3. Integrate StreamFX into the OBS Studio build flow: - 1. Navigate to either of these directories: - - **With UI:** `/UI/frontend-plugins` - - **Without UI:** `/plugins` + 1. Navigate to `/UI/frontend-plugins` 2. Open a `git` enabled shell (git-bash on windows). 3. Run `git submodule add 'https://github.com/Xaymar/obs-StreamFX.git' streamfx`. 4. Run `git submodule update --init --recursive`. 5. Append the line `add_subdirectory(streamfx)` to the `CMakeLists.txt` file in the same directory. -4. Run the same script(s) from step 2 again. +4. Run the same steps from the build guide in step 2 again. 5. Done. StreamFX is now part of the build. @@ -54,8 +52,8 @@ This document intends to guide you through the process of building StreamFX. It A Node.JS based tool is provided toread and parse the `/third-party/obs-studio/buildspec.json` file. See `/.github/workflows/main.yml` on usage and output parsing. - **MacOS** A Node.JS based tool is provided toread and parse the `/third-party/obs-studio/buildspec.json` file. See `/.github/workflows/main.yml` on usage and output parsing. - - Linux: - - **Debian / Ubuntu:** `sudo apt install qt6-base-dev qt6-base-private-dev libqt6svg6-dev` + - **Debian / Ubuntu:** + `sudo apt install qt6-base-dev qt6-base-private-dev libqt6svg6-dev` - [CURL](https://curl.se/): - **Windows** A Node.JS based tool is provided toread and parse the `/third-party/obs-studio/buildspec.json` file. See `/.github/workflows/main.yml` on usage and output parsing.