README 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. _ _ ____ _
  2. ___| | | | _ \| |
  3. / __| | | | |_) | |
  4. | (__| |_| | _ <| |___
  5. \___|\___/|_| \_\_____|
  6. Include files for libcurl, external users.
  7. They're all placed in the curl subdirectory here for better fit in any kind
  8. of environment. You should include files from here using...
  9. #include <curl/curl.h>
  10. ... style and point the compiler's include path to the directory holding the
  11. curl subdirectory. It makes it more likely to survive future modifications.
  12. NOTE FOR LIBCURL HACKERS
  13. All the include files in this tree are written and intended to be installed on
  14. a system that may serve multiple platforms and multiple applications, all
  15. using libcurl (possibly even different libcurl installations using different
  16. versions). Therefore, all header files in here must obey these rules:
  17. * They cannot depend on or use configure-generated results from libcurl's or
  18. curl's directories. Other applications may not run configure as (lib)curl
  19. does, and using platform dependent info here may break other platforms.
  20. * We cannot assume anything else but very basic compiler features being
  21. present. While libcurl requires an ANSI C compiler to build, some of the
  22. earlier ANSI compilers clearly can't deal with some preprocessor operators.
  23. * Newlines must remain unix-style for older compilers' sake.
  24. * Comments must be written in the old-style /* unnested C-fashion */
  25. To figure out how to do good and portable checks for features, operating
  26. systems or specific hardwarare, a very good resource is Bjorn Reese's
  27. collection at http://predef.sf.net/