README.md

   1 c-ares
   2 ======
   3
   4 [![Build Status](https://travis-ci.org/c-ares/c-ares.svg?branch=master)](https://travis-ci.org/c-ares/c-ares)
   5 [![Windows Build Status](https://ci.appveyor.com/api/projects/status/03i7151772eq3wn3/branch/master?svg=true)](https://ci.appveyor.com/project/c-ares/c-ares)
   6 [![Coverage Status](https://coveralls.io/repos/c-ares/c-ares/badge.svg?branch=master&service=github)](https://coveralls.io/github/c-ares/c-ares?branch=master)
   7 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/291/badge)](https://bestpractices.coreinfrastructure.org/projects/291)
   8
   9 This is c-ares, an asynchronous resolver library.  It is intended for
  10 applications which need to perform DNS queries without blocking, or need to
  11 perform multiple DNS queries in parallel.  The primary examples of such
  12 applications are servers which communicate with multiple clients and programs
  13 with graphical user interfaces.
  14
  15 The full source code is available in the 'c-ares' release archives, and in a
  16 git repository: http://github.com/c-ares/c-ares
  17
  18 If you find bugs, correct flaws, have questions or have comments in general in
  19 regard to c-ares (or by all means the original ares too), get in touch with us
  20 on the c-ares mailing list: http://cool.haxx.se/mailman/listinfo/c-ares
  21
  22 c-ares is of course distributed under the same MIT-style license as the
  23 original ares.
  24
  25 You'll find all c-ares details and news here:
  26         https://c-ares.haxx.se/
  27
  28
  29 Notes for c-ares hackers
  30 ------------------------
  31
  32 * The distributed `ares_build.h` file is only intended to be used on systems
  33   which can not run the also distributed configure script.
  34
  35 * The distributed `ares_build.h` file is generated as a copy of `ares_build.h.dist`
  36   when the c-ares source code distribution archive file is originally created.
  37
  38 * If you check out from git on a non-configure platform, you must run the
  39   appropriate `buildconf*` script to set up `ares_build.h` and other local files
  40   before being able to compile the library.
  41
  42 * On systems capable of running the `configure` script, the `configure` process
  43   will overwrite the distributed `ares_build.h` file with one that is suitable
  44   and specific to the library being configured and built, this new file is
  45   generated from the `ares_build.h.in` template file.
  46
  47 * If you intend to distribute an already compiled c-ares library you **MUST**
  48   also distribute along with it the generated `ares_build.h` which has been
  49   used to compile it. Otherwise the library will be of no use for the users of
  50   the library that you have built. It is **your** responsibility to provide this
  51   file. No one at the c-ares project can know how you have built the library.
  52
  53 * File `ares_build.h` includes platform and configuration dependent info,
  54   and must not be modified by anyone. Configure script generates it for you.
  55
  56 * We cannot assume anything else but very basic compiler features being
  57   present. While c-ares requires an ANSI C compiler to build, some of the
  58   earlier ANSI compilers clearly can't deal with some preprocessor operators.
  59
  60 * Newlines must remain unix-style for older compilers' sake.
  61
  62 * Comments must be written in the old-style /* unnested C-fashion */
  63
  64 * Try to keep line lengths below 80 columns.