README.md
1# estd
2
3`estd` is a header-only C++ library providing some additional utilities in the style of the standard library.
4
5The include files are ordered hierarchically in the style of Boost.
6You can include a whole sublibrary with a single header, or pick only the bits you want to use.
7
8```cpp
9// Include all tuple utilities in one go:
10#include <estd/tuple.hpp>
11
12// Include only the estd::for_each family of functions:
13#include <estd/tuple/for_each.hpp>
14
15
16```
17
18An overview of the libraries currently contained in `estd`:
19
20* **convert**: A standardized conversion convention, with support for custom tagged conversion functions.
21* **range**: Utility functions to operate on ranges of elements.
22* **result**: A type that can hold either an error or a value.
23* **traits**: Some additional type traits not in #include <type_traits>
24* **tuple**: Utility functions to work with tuples easily (looping, folding, zipping, transforming).
25* **utility**: Assorted small utility functions and classes.
26
27`estd` is licensed under the BSD 3-Clause license.
28