diff options
author | Daniel Stenberg <daniel@haxx.se> | 2020-09-30 14:57:38 +0200 |
---|---|---|
committer | Daniel Stenberg <daniel@haxx.se> | 2020-09-30 22:45:41 +0200 |
commit | d0c77730ed2056b05e5a379f7765d51cac4c23cc (patch) | |
tree | 6b6202e4bdc62d41e76a6092eb3cd390106692cc /include | |
parent | 7b9e3c4b4c90faa65cf226c8355be27a52cd01b8 (diff) | |
download | curl-d0c77730ed2056b05e5a379f7765d51cac4c23cc.tar.gz |
include/README: convert to markdown
Closes #6028
Diffstat (limited to 'include')
-rw-r--r-- | include/Makefile.am | 2 | ||||
-rw-r--r-- | include/README | 18 | ||||
-rw-r--r-- | include/README.md | 14 |
3 files changed, 15 insertions, 19 deletions
diff --git a/include/Makefile.am b/include/Makefile.am index e33aecc00..611ebdfaa 100644 --- a/include/Makefile.am +++ b/include/Makefile.am @@ -21,6 +21,6 @@ ########################################################################### SUBDIRS = curl -EXTRA_DIST = README +EXTRA_DIST = README.md AUTOMAKE_OPTIONS = foreign no-dependencies diff --git a/include/README b/include/README deleted file mode 100644 index 091ef76d1..000000000 --- a/include/README +++ /dev/null @@ -1,18 +0,0 @@ - _ _ ____ _ - ___| | | | _ \| | - / __| | | | |_) | | - | (__| |_| | _ <| |___ - \___|\___/|_| \_\_____| - -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. diff --git a/include/README.md b/include/README.md new file mode 100644 index 000000000..bd28a30e8 --- /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. |