aboutsummaryrefslogtreecommitdiffstats
path: root/include/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'include/README.md')
-rw-r--r--include/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/include/README.md b/include/README.md
new file mode 100644
index 00000000..bd28a30e
--- /dev/null
+++ b/include/README.md
@@ -0,0 +1,14 @@
+# include
+
+Public include files for libcurl, external users.
+
+They're all placed in the curl subdirectory here for better fit in any kind of
+environment. You must include files from here using...
+
+ #include <curl/curl.h>
+
+... style and point the compiler's include path to the directory holding the
+curl subdirectory. It makes it more likely to survive future modifications.
+
+The public curl include files can be shared freely between different platforms
+and different architectures.