X-Git-Url: https://git.lttng.org/?p=lttng-ust.git;a=blobdiff_plain;f=doc%2Fexamples%2FREADME.md;fp=doc%2Fexamples%2FREADME.md;h=3208139cce6cd4ea2c0a3b77c82a97861715bd50;hp=0000000000000000000000000000000000000000;hb=e03d7c66c57bf268b87296566a5160039f35ccfb;hpb=79f8dc6f50b20fb6b1d99f9bd97d70aa361bc6ad

diff --git a/doc/examples/README.md b/doc/examples/README.md
new file mode 100644
index 00000000..3208139c
--- /dev/null
+++ b/doc/examples/README.md
@@ -0,0 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2023 EfficiOS, Inc.
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+To build the examples from the source tree, the `BUILD_EXAMPLES_FROM_TREE`
+environment variable must be defined. This will ensure the examples Makefiles
+use the source tree's public header files and binaries.