From 2d541fd31a50cc5a273fd3faa010f66ffe4abb15 Mon Sep 17 00:00:00 2001
From: Oliver Reiche <oliver.reiche@huawei.com>
Date: Thu, 22 Dec 2022 18:21:16 +0100
Subject: Add examples for interoperability with CMake

- consuming CMake libraries
- being consumed by CMake
---
 etc/README.template.md | 8 ++++++++
 etc/generate-doc.sh    | 3 ++-
 2 files changed, 10 insertions(+), 1 deletion(-)
 create mode 100644 etc/README.template.md

(limited to 'etc')

diff --git a/etc/README.template.md b/etc/README.template.md
new file mode 100644
index 0000000..b32383a
--- /dev/null
+++ b/etc/README.template.md
@@ -0,0 +1,8 @@
+# C/C++ rules for the `just` build system
+
+A collection of rules for building C/C++ libraries and binaries.
+
+For interoperability with CMake projects, see
+- [consume CMake libraries](./doc/consume-cmake-libraries.org)
+- [being consumed by CMake](./doc/being-consumed-by-cmake.org)
+
diff --git a/etc/generate-doc.sh b/etc/generate-doc.sh
index 6f1b396..96bf251 100755
--- a/etc/generate-doc.sh
+++ b/etc/generate-doc.sh
@@ -43,7 +43,8 @@ doc2md() {
 }
 
 rm -f "$OUTFILE"
-( doc2md rules CC binary
+( cat "$ROOT/etc/README.template.md"
+  doc2md rules CC binary
   doc2md rules CC library
   doc2md rules CC/prebuilt library
   doc2md rules CC install-with-deps
-- 
cgit v1.2.3