From ce370332cee9182e1bbad67c02c2257ad3720528 Mon Sep 17 00:00:00 2001 From: jzmaddock Date: Mon, 15 Oct 2018 17:57:12 +0100 Subject: [PATCH] Documentation update: * Fix URL of bug tracker to point to Github. * Regenerate docs. * Add README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ doc/config.qbk | 2 +- doc/html/index.html | 4 ++-- 3 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..d98d250c --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +Boost Config Library +============================ + +This library provides configuration support for the Boost C++ libraries. + +The full documentation is available on [boost.org](http://www.boost.org/doc/libs/release/libs/config/index.html). + +## Support, bugs and feature requests ## + +Bugs and feature requests can be reported through the [Gitub issue tracker](https://github.com/boostorg/config/issues) +(see [open issues](https://github.com/boostorg/config/issues) and +[closed issues](https://github.com/boostorg/config/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed)). + +You can submit your changes through a [pull request](https://github.com/boostorg/config/pulls). + +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]. + + +## Development ## + +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)): + + git clone https://github.com/boostorg/boost + cd boost + git submodule update --init + +The Boost Config Library is located in `libs/config/`. + +### Running tests ### +First, make sure you are in `libs/config/test`. +You can either run all the tests listed in `Jamfile.v2` or run a single test: + + ../../../b2 <- run all tests + ../../../b2 config_info <- single test + diff --git a/doc/config.qbk b/doc/config.qbk index 3dc11ba6..584fc298 100644 --- a/doc/config.qbk +++ b/doc/config.qbk @@ -29,7 +29,7 @@ Distributed under the Boost Software License, Version 1.0. [/ Other web resources ] [def __STL_PORT__ [@http://stlport.sourceforge.net STLport]] -[def __BOOST_TRACKER__ [@https://svn.boost.org/trac/boost/newticket Trac]] +[def __BOOST_TRACKER__ [@https://github.com/boostorg/config/issues Github]] [def __CORE_LANGUAGE_DR337__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#337 Core Language DR337]] [def __PRINCIPLES_AND_PATTERNS_ARTICLE__ [@http://www.objectmentor.com/resources/articles/Principles_and_Patterns.pdf following article]] diff --git a/doc/html/index.html b/doc/html/index.html index 6858d0a9..38d8c0d3 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -162,7 +162,7 @@

Boost library users can request support for additional compilers or platforms - by visiting our Trac + by visiting our Github and submitting a support request.

@@ -993,7 +993,7 @@ - +

Last revised: August 16, 2018 at 10:24:31 GMT

Last revised: October 15, 2018 at 16:56:00 GMT