README

!alt text

JUCE is an open-source cross-platform C++ application framework for creating
desktop and mobile applications, including VST, VST3, AU, AUv3, AAX and LV2
audio plug-ins and plug-in hosts. JUCE can be easily integrated with existing
projects via CMake, or can be used as a project generation tool via the
Projucer, which supports exporting projects for Xcode (macOS
and iOS), Visual Studio, Android Studio, and Linux Makefiles as well as
containing a source code editor.

 Getting Started

The JUCE repository contains a
master and
develop branch. The
develop branch contains the latest bug fixes and features and is periodically
merged into the master branch in stable tagged
releases (the latest release
containing pre-built binaries can also be downloaded from the JUCE
website).

JUCE projects can be managed with either CMake or the Projucer (JUCE's own
project-configuration tool).

 CMake

Version 3.22 or higher is required. To use CMake, you will need to install it,
either from your system package manager or from the official download
page. For comprehensive documentation on JUCE's
CMake API, see the JUCE CMake documentation. For
examples which may be useful as starting points for new CMake projects, see the
CMake examples directory.

 Building Examples Using CMake

To use CMake to build the examples and extras bundled with JUCE, simply clone
JUCE and then run the following commands, replacing "DemoRunner" with the name
of the target you wish to build.

    cd /path/to/JUCE
    cmake . -B cmake-build -DJUCE_BUILD_EXAMPLES=ON -DJUCE_BUILD_EXTRAS=ON
    cmake --build cmake-build --target DemoRunner

 The Projucer

The repository doesn't contain a pre-built Projucer so you will need to build it
for your platform - Xcode, Visual Studio and Linux Makefile projects are located
in extras/Projucer/Builds (the minimum system
requirements are listed in the minimum system
requirements section below). The Projucer can
then be used to create new JUCE projects, view tutorials and run examples.

 API Documentation

The API documentation is generated directly from the Doxygen comments in the
module headers themselves and the source code is the most complete and
up-to-date documentation available. For the master and develop branches
specifically the documentation is also published at
https://docs.juce.com/master and
https://docs.juce.com/develop respectively.

To find accurate documentation for the version of JUCE being used, particularly
when using an AI coding assistant, please note the following:

- The main header for each module juce_/juce_.h lists the
  module's public headers along with the module's dependencies. The format of a
  JUCE module is described in more detail
  here
- To find the documentation for a class you can search the headers for its
  declaration and read the comment block above it and above each member. For
  example, to search for the AudioProcessorValueTreeState class:

      grep -rlE "^\s(class|struct)\s+(JUCE_API\s+)?AudioProces