From 391b6438558067b618fb015afab4180c12301162 Mon Sep 17 00:00:00 2001
From: chao an <anchao@xiaomi.com>
Date: Mon, 10 Jul 2023 09:37:27 +0800
Subject: [PATCH] apps/cmake: add some note on cmake header

| # Important note:
| # This CMakeLists.txt is not meant as a top-level CMakeLists.txt. Instead,
| # CMake must be run using the top-level CMakeLists.txt from the nuttx
| # repository and point to this directory via NUTTX_APPS_DIR. For example:
| #   cmake -S <nuttx-dir> -B <build-dir> [...] -DNUTTX_APPS_DIR=<apps-dir>

Signed-off-by: chao an <anchao@xiaomi.com>
---
 CMakeLists.txt | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index dbe06949d..2b54a3fcb 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -18,6 +18,14 @@
 #
 # ##############################################################################
 
+# ~~~
+# Important note:
+# This CMakeLists.txt is not meant as a top-level CMakeLists.txt. Instead,
+# CMake must be run using the top-level CMakeLists.txt from the nuttx
+# repository and point to this directory via NUTTX_APPS_DIR. For example:
+#   cmake -S <nuttx-dir> -B <build-dir> [...] -DNUTTX_APPS_DIR=<apps-dir>
+# ~~~
+
 if(CONFIG_APPS_DIR)
   nuttx_add_library(apps)
   if(NOT EXISTS {NUTTX_APPS_BINDIR}/dummy.c)