Using Sketchbook

The Arduino IDE has a concept named Sketchbook, which is a directory to store all 3rd party libraries, examples and sketches in. It usually goes well with the Library Manager bundled inside the IDE.

Arduino-CMake can make use of that automatically!

There are 2 ways to enable its' use by the framework:

1. Enable the AUTO_SET_SKETCHBOOK_PATH option either by passing it to cmake using -D or by setting it as a cache variable before the call to project() in your CMakeLists.txt file.
2. Manually set the ARDUINO_CMAKE_SKETCHBOOK_PATH variable, preferably as a cache variable.

Currently, the use of the Sketchbook Location can be witnessed when finding 3rd Party libraries.

Note: The Arduino IDE itself must be run at least once in order to create a preferences file where the Sketchbook Location is pointed, so make sure you do that before leveraging Sketchbook support!