summaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
Diffstat (limited to 'scripts')
-rw-r--r--scripts/gen_amalgamation.sh5
-rw-r--r--scripts/gen_apidocs.sh3
-rw-r--r--scripts/header_check.sh1
3 files changed, 8 insertions, 1 deletions
diff --git a/scripts/gen_amalgamation.sh b/scripts/gen_amalgamation.sh
new file mode 100644
index 0000000..56df62e
--- /dev/null
+++ b/scripts/gen_amalgamation.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# Generates a single amalgamation C header file that includes all public types and functions.
+#
+# This makes including and linking Celeritas very easy.
diff --git a/scripts/gen_apidocs.sh b/scripts/gen_apidocs.sh
new file mode 100644
index 0000000..afad30e
--- /dev/null
+++ b/scripts/gen_apidocs.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+# Generates a static webpage for the public C-API of `celeritas-core`
diff --git a/scripts/header_check.sh b/scripts/header_check.sh
deleted file mode 100644
index 2edd9fe..0000000
--- a/scripts/header_check.sh
+++ /dev/null
@@ -1 +0,0 @@
-# TODO - check .h files for a valid header with @brief and #pragma once \ No newline at end of file