summaryrefslogtreecommitdiff
path: root/etc
diff options
context:
space:
mode:
Diffstat (limited to 'etc')
-rw-r--r--etc/README.template.md8
-rwxr-xr-xetc/generate-doc.sh3
2 files changed, 10 insertions, 1 deletions
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