Skip to content

Commit a2267fd

Browse files
Merge pull request #54 from connectivecpp/develop
Working on Doxygen gen docs
2 parents e16ef3c + 3993cc6 commit a2267fd

File tree

3 files changed

+2665
-5
lines changed

3 files changed

+2665
-5
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,22 @@ The [`shared_buffer`](https://github.com/connectivecpp/shared-buffer) library fr
4545

4646
## Supported Compilers
4747

48-
Continuous integration workflows build and unit test on g++ (through Ubuntu), MSVC (through Windows), and clang (through macOS).
48+
Continuous integration workflows build and unit test on g++ (through Ubuntu) and MSVC (through Windows). Clang (through macOS) will be supported for continuous integration when C++ 20 thread feature `std::stop_source` (and related functionality) is fully supported in the GitHub macOS runners. The C++ 20 thread features are only needed for unit testing (through `wait_queue`). Conditional unit test builds (on macOS) could be implemented, but macOS clang updating to a standard that is now almost six years old is a better solution.
4949

5050
## Unit Test Dependencies
5151

5252
The unit test code uses [Catch2](https://github.com/catchorg/Catch2). If the `CHOPS_NET_IP_BUILD_TESTS` flag is provided to Cmake (see commands below) the Cmake configure / generate will download the Catch2 library as appropriate using the [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) dependency manager. If Catch2 (v3 or greater) is already installed using a different package manager (such as Conan or vcpkg), the `CPM_USE_LOCAL_PACKAGES` variable can be set which results in `find_package` being attempted. Note that v3 (or later) of Catch2 is required.
5353

5454
Specific version (or branch) specs for the Catch2 dependency is in the [test/CMakeLists.txt](test/CMakeLists.txt) file, look for the `CPMAddPackage` command.
5555

56+
The unit tests use the following libraries from Connective C++:
57+
- [wait-queue](https://github.com/connectivecpp/wait-queue)
58+
- [binary-serialize](https://github.com/connectivecpp/binary-serialize)
59+
- [utility-rack](https://github.com/connectivecpp/utility-rack)
60+
5661
## Example Dependencies
5762

58-
(Fill in).
63+
The example apps do not (currently) have external dependencies other than the required dependencies for `chops_net_ip`.
5964

6065
## Build and Run Unit Tests
6166

0 commit comments

Comments
 (0)