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