aboutsummaryrefslogtreecommitdiff
path: root/src/README
diff options
context:
space:
mode:
authorjthorn <jthorn@f88db872-0e4f-0410-b76b-b9085cfa78c5>2001-09-16 12:59:20 +0000
committerjthorn <jthorn@f88db872-0e4f-0410-b76b-b9085cfa78c5>2001-09-16 12:59:20 +0000
commita42af45b9455cf3c24ef6d5316db3951e72a61b0 (patch)
treeca533ed209d680dfb7ff914d85e6baa66827a4f7 /src/README
parent4dcb42ba546aa8a1be5a9474b38ed2f8b6326a8b (diff)
Modified Files:
libutil/README util/README describe main C++ classes Added Files: README describe subdirectories git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/AHFinderDirect/trunk@350 f88db872-0e4f-0410-b76b-b9085cfa78c5
Diffstat (limited to 'src/README')
-rw-r--r--src/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/README b/src/README
new file mode 100644
index 0000000..27fc707
--- /dev/null
+++ b/src/README
@@ -0,0 +1,21 @@
+This is the top-level source directory for the AHFinderDirect thorn.
+See ../doc/ for further documentation.
+
+The main subdirectories under this directory are:
+gr/ relativity code; all knowledge of the actual apparent
+ horizon equation lives in the code in this directory
+maple/ Maple code to generate C/C++ from complicated expressions
+util/ basic multipatch infrastructure for storing and
+ finite differencing gridfns in angular coordinates
+ on the surface of a 2-sphere
+jt/ symlinks to various header files in other directories of
+ the source tree
+libinterp/ interpolation library
+libutil/ low-level utility library: templates and inline functions
+ for things like integer <--> floating-point linear maps,
+ N-dimensional arrays, fuzzy floating-point comparisons, etc
+
+try/ little test programs to experiment with compilers
+ and their bugs, fancy C++ features, etc etc
+archive/ obselete code that might come in handy for reuse or ideas
+ some day