summaryrefslogtreecommitdiffstats
path: root/src/boost/libs/regex/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/boost/libs/regex/README.md')
-rw-r--r--src/boost/libs/regex/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/src/boost/libs/regex/README.md b/src/boost/libs/regex/README.md
new file mode 100644
index 000000000..2c03881d1
--- /dev/null
+++ b/src/boost/libs/regex/README.md
@@ -0,0 +1,36 @@
+Boost Regex Library
+============================
+
+The Boost Regex library provides regular expression support for C++, this library is the ancestor to std::regex and still goes beyond
+and offers some advantages to, the standard version.
+
+The full documentation is available on [boost.org](http://www.boost.org/doc/libs/release/libs/regex/index.html).
+
+## Support, bugs and feature requests ##
+
+Bugs and feature requests can be reported through the [Gitub issue tracker](https://github.com/boostorg/regex/issues)
+(see [open issues](https://github.com/boostorg/regex/issues) and
+[closed issues](https://github.com/boostorg/regex/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed)).
+
+You can submit your changes through a [pull request](https://github.com/boostorg/regex/pulls).
+
+There is no mailing-list specific to Boost Regex, although you can use the general-purpose Boost [mailing-list](http://lists.boost.org/mailman/listinfo.cgi/boost-users) using the tag [regex].
+
+
+## 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 Regex Library is located in `libs/regex/`.
+
+### Running tests ###
+First, make sure you are in `libs/regex/test`.
+You can either run all the tests listed in `Jamfile.v2` or run a single test:
+
+ ../../../b2 <- run all tests
+ ../../../b2 regex_regress <- single test
+