libs/config/README.md

   1 Boost Config Library
   2 ============================
   3
   4 This library provides configuration support for the Boost C++ libraries.
   5
   6 The full documentation is available on [boost.org](http://www.boost.org/doc/libs/release/libs/config/index.html).
   7
   8 |                  |  Master  |   Develop   |
   9 |------------------|----------|-------------|
  10 | Travis           | [![Build Status](https://travis-ci.org/boostorg/config.svg?branch=master)](https://travis-ci.org/boostorg/config)  |  [![Build Status](https://travis-ci.org/boostorg/config.png)](https://travis-ci.org/boostorg/config) |
  11 | Appveyor         | [![Build status](https://ci.appveyor.com/api/projects/status/wo2n2mhoy8vegmuo/branch/master?svg=true)](https://ci.appveyor.com/project/jzmaddock/config/branch/master) | [![Build status](https://ci.appveyor.com/api/projects/status/wo2n2mhoy8vegmuo/branch/develop?svg=true)](https://ci.appveyor.com/project/jzmaddock/config/branch/develop) |
  12
  13 ## Support, bugs and feature requests ##
  14
  15 Bugs and feature requests can be reported through the [Gitub issue tracker](https://github.com/boostorg/config/issues)
  16 (see [open issues](https://github.com/boostorg/config/issues) and
  17 [closed issues](https://github.com/boostorg/config/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed)).
  18
  19 You can submit your changes through a [pull request](https://github.com/boostorg/config/pulls).
  20
  21 There is no mailing-list specific to Boost Config, although you can use the general-purpose Boost [mailing-list](http://lists.boost.org/mailman/listinfo.cgi/boost-users) using the tag [config].
  22
  23
  24 ## Development ##
  25
  26 Clone the whole boost project, which includes the individual Boost projects as submodules ([see boost+git doc](https://github.com/boostorg/boost/wiki/Getting-Started)):
  27
  28     git clone https://github.com/boostorg/boost
  29     cd boost
  30     git submodule update --init
  31
  32 The Boost Config Library is located in `libs/config/`.
  33
  34 ### Running tests ###
  35 First, make sure you are in `libs/config/test`.
  36 You can either run all the tests listed in `Jamfile.v2` or run a single test:
  37
  38     ../../../b2                        <- run all tests
  39     ../../../b2 config_info            <- single test
  40
  41 ### For developers ###
  42 Please check the [Guidelines for Boost Authors](http://www.boost.org/doc/libs/release/libs/config/doc/html/boost_config/guidelines_for_boost_authors.html). from the full documentation.