build_options.md
February 2, 2025 ยท View on GitHub
These are options you can use to customize your own build of Notes.
You should set those while invoking CMake to build the project. See the examples section below.
Options
| Name | Default value | Supported values | Description |
|---|---|---|---|
CMAKE_OSX_DEPLOYMENT_TARGET (macOS-only) | 10.15 | (any macOS version) | Minimum macOS version to target for deployment |
GIT_REVISION | OFF | ON / OFF | Append the current git revision to the app's version string |
UPDATE_CHECKER | ON | ON / OFF | Enable or disable both the update checker and auto-updater |
PRO_VERSION | ON | ON / OFF | Enable or disable Notes Pro features |
ENABLE_ASAN | OFF | ON / OFF | Enable AddressSanitizer (ASan) for debugging |
Examples
To build Notes without any update-checking feature:
cmake -B build -DUPDATE_CHECKER=OFF
To build Notes in Release mode (for other modes, check the CMake documentation):
cmake -B build -DCMAKE_BUILD_TYPE=Release