Add OBS_BUILD_DIR to docs

EZ64cool commented 7 months ago

Description

Adds OBS_BUILD_DIR to README.md

Motivation and Context

This is a really useful CMAKE argument that makes iterative debugging so much easier, before finding this I would manually copy/paste binaries and data from the release folder into a local obs-studio directory. And it's currently missing from the docs.

How Has This Been Tested?

None needed

Types of changes

Documentation (a change to documentation pages)

Checklist:

[X] My code has been run through clang-format.
[X] I have read the contributing document.
[X] My code is not on the master branch.
[X] The code has been tested.
[X] All commit messages are properly formatted and commits squashed where appropriate.
[X] I have included updates to all appropriate documentation.

PatTheMav commented 7 months ago

The variable only exists for legacy purposes, the correct way is to configure the project with an INSTALL_PREFIX that points to a directory that a local OBS installation uses to load plugins and just run cmake --install to update the installed version.

It was (and is) also only available on Windows, whereas using the INSTALL_PREFIX is supported by all platforms. Thus it's not documented, because it's not supposed to be used in the first place.

EZ64cool commented 7 months ago

Okay yeah using INSTALL_PREFIX is a good alternative, as a nice bonus I can now do everything from inside VSCode. Thank you for the tip

obsproject / obs-plugintemplate