@@ -27,8 +27,36 @@ The following compilers are supported:
2727* gcc 13
2828* gcc 14
2929
30- In general, `stdx` supports the C++17 standard; however some functionality is
31- available only in 20 and later.
30+ In general, `stdx` supports the C\\++17 standard; however some functionality is
31+ available only in C++20 and later.
32+ 
33+ === Dependencies
34+ 
35+ `stdx` depends on:
36+ 
37+ * https://www.boost.org/libs/mp11/[boost mp11]
38+ * https://github.com/fmtlib/fmt[fmtlib]
39+ * https://github.com/intel/cpp-baremetal-concurrency/[baremetal-concurrency]
40+ 
41+ NOTE: `libfmt` is used at compile-time only; there is no runtime formatting in
42+ `stdx`.
43+ 
44+ === Getting Started
45+ 
46+ `stdx` is a header-only library, so you can get started by cloning the
47+ repository (or bringing it in as a submodule) and adding the include directory
48+ to your build target. Depending on which part(s) of `stdx` you are using, you
49+ may also need to pull in the dependencies.
50+ 
51+ Alternatively, consuming `stdx` with https://github.com/cpm-cmake/CPM.cmake[CPM]
52+ can be a one-liner:
53+ 
54+ [source,cmake]
55+ ---- 
56+ cpmaddpackage("gh:intel/cpp-std-extensions#1abcdef") 
57+ ---- 
58+ 
59+ Where `1abcdef` is the git hash.
3260
3361=== Synopsis
3462
@@ -54,16 +82,19 @@ The following headers are available:
5482* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/cx_queue.hpp[`cx_queue.hpp`]
5583* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/cx_set.hpp[`cx_set.hpp`]
5684* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/cx_vector.hpp[`cx_vector.hpp`]
85+ * https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/env.hpp[`env.hpp`]
5786* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/for_each_n_args.hpp[`for_each_n_args.hpp`]
5887* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/function_traits.hpp[`function_traits.hpp`]
5988* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/functional.hpp[`functional.hpp`]
6089* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/intrusive_forward_list.hpp[`intrusive_forward_list.hpp`]
6190* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/intrusive_list.hpp[`intrusive_list.hpp`]
6291* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/iterator.hpp[`iterator.hpp`]
92+ * https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/latched.hpp[`latched.hpp`]
6393* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/memory.hpp[`memory.hpp`]
6494* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/numeric.hpp[`numeric.hpp`]
6595* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/optional.hpp[`optional.hpp`]
6696* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/panic.hpp[`panic.hpp`]
97+ * https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/pp_map.hpp[`pp_map.hpp`]
6798* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/priority.hpp[`priority.hpp`]
6899* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/ranges.hpp[`ranges.hpp`]
69100* https://github.com/intel/cpp-std-extensions/blob/main/include/stdx/rollover.hpp[`rollover.hpp`]
0 commit comments