aboutsummaryrefslogtreecommitdiff
path: root/src/include/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/README')
-rw-r--r--src/include/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/include/README b/src/include/README
new file mode 100644
index 0000000..a616529
--- /dev/null
+++ b/src/include/README
@@ -0,0 +1,11 @@
+This directory holds header files common to all of this thorn.
+
+stdc.h
+ is a low-level file defining Jonathan Thornburg's "dialect" of C,
+ including the "then" pseudo-keyword you'll see all through the
+ source code
+
+config.hh
+ defines compile-time configuration for this thorn, eg the "fp"
+ typedef (= CCTK_REAL), the choice of 2nd vs 4th order finite
+ differencing, etc etc