aboutsummaryrefslogtreecommitdiffhomepage
path: root/compat/README
diff options
context:
space:
mode:
Diffstat (limited to 'compat/README')
-rw-r--r--compat/README16
1 files changed, 16 insertions, 0 deletions
diff --git a/compat/README b/compat/README
new file mode 100644
index 00000000..cd32c56f
--- /dev/null
+++ b/compat/README
@@ -0,0 +1,16 @@
+notmuch/comapt
+
+This directory consists of two things:
+
+1. Small programs used by the notmuch configure script to test for the
+ availability of certain system features, (library functions, etc.).
+
+ For example: have_getline.c
+
+2. Compatibility implementations of those system features for systems
+ that don't provide their own versions.
+
+ For example: getline.c
+
+ The compilation of these files is made conditional on the output of
+ the test programs from [1].