include/README

   1                                   _   _ ____  _
   2                               ___| | | |  _ \| |
   3                              / __| | | | |_) | |
   4                             | (__| |_| |  _ <| |___
   5                              \___|\___/|_| \_\_____|
   6
   7 Include files for libcurl, external users.
   8
   9 They're all placed in the curl subdirectory here for better fit in any kind
  10 of environment. You must include files from here using...
  11
  12         #include <curl/curl.h>
  13
  14 ... style and point the compiler's include path to the directory holding the
  15 curl subdirectory. It makes it more likely to survive future modifications.
  16
  17 NOTE FOR LIBCURL HACKERS
  18
  19 * If you check out from git on a non-configure platform, you must run the
  20   appropriate buildconf* script to set up files before being able of compiling
  21   the library.
  22
  23 * We cannot assume anything else but very basic compiler features being
  24   present. While libcurl requires an ANSI C compiler to build, some of the
  25   earlier ANSI compilers clearly can't deal with some preprocessor operators.
  26
  27 * Newlines must remain unix-style for older compilers' sake.
  28
  29 * Comments must be written in the old-style /* unnested C-fashion */
  30
  31 To figure out how to do good and portable checks for features, operating
  32 systems or specific hardwarare, a very good resource is Bjorn Reese's
  33 collection at https://sourceforge.net/p/predef/wiki/