tytan652 2bd23cd50d libobs,cmake: Replace vendored SIMD Everywhere by prefix/system install		1 year ago
..
.functions	1cfa06a2aa CI: Add zsh-based build framework files for macOS	2 years ago
modules	2bd23cd50d libobs,cmake: Replace vendored SIMD Everywhere by prefix/system install	1 month ago
steam	4c5d3e77c9 build-aux: Add shader cache cleanup to steam uninstall script	2 years ago
.run-format.zsh	fbf08cc944 build-aux: Add test directory to clang-format file list	2 months ago
README.md	a5ebb05c60 CI: Remove run-cmake-format action	1 year ago
com.obsproject.Studio.json	2bd23cd50d libobs,cmake: Replace vendored SIMD Everywhere by prefix/system install	1 month ago
format-manifest.py	d6b98def22 CI: Add new repository actions for GitHub	2 years ago
run-clang-format	1cfa06a2aa CI: Add zsh-based build framework files for macOS	2 years ago
run-gersemi	19d3e30a3a CI: Replace cmake-format with gersemi for CMake file format checks	1 year ago
run-swift-format	1cfa06a2aa CI: Add zsh-based build framework files for macOS	2 years ago

`build-aux` folder

This folder contains:

Various formatting scripts:
- run-clang-format which formats C/C++/ObjC/ObjC++ files
- run-gersemi which formats CMake files
- run-swift-format which formats Swift files
- format-manifest.py which formats Flatpak manifest JSON files
The Flatpak manifest used to build OBS Studio
Files used for Steam packaging

Formatting scripts

This script allows to check the formatting and/or format of C/C++/ObjC/ObjC++ files and requires ZSH and a specific version of clang-format.

If the script does not find the latter it will return the required version, we provide clang-format Homebrew formulas in our homebrew-tools repo.

Example of use:

./build-aux/run-clang-format

This script allows to check the formatting and/or format of the CMake files and requires ZSH and gersemi Python package.

Example of use:

./build-aux/run-gersemi

This script allows to check the formatting and/or format of the Swift files and requires ZSH and swift-format.

Example of use:

./build-aux/run-swift-format

This script allows to check the formatting and/or format of the Flatpak manifest and its modules.

Example of use:

python3 ./build-aux/format-manifest.py com.obsproject.Studio.json

The manifest is composed of multiple files:

Modules are ordered/dispatched in numbered categories following a short list of rules:

A module must not depend on another module from the same category, so a module can only depend on modules from lower numbered categories.
A module without dependencies must be placed in the highest numbered category in use, excluding categories meant for specific types of dependency.

Actual categories: