Skip to content

Commit 4e33a7a

Browse files
authored
docs: add note about Boost 1.83 incompatability to README.md (#408)
1 parent 4302e8b commit 4e33a7a

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,13 @@ This includes shared libraries, used by SDKs and other tools, as well as SDKs.
3636
1. C++17 and above
3737
1. CMake 3.19 or higher
3838
1. Ninja (if using the included build scripts)
39-
1. Boost version 1.81 or higher
39+
1. Boost version 1.81 or higher (**excluding** Boost 1.83, see note below)
4040
1. OpenSSL
4141

42+
> [!NOTE]
43+
> Boost 1.83 is not supported due to an incompatibility in Boost.JSON. This issue appears to be resolved
44+
> in versions prior and subsequent to 1.83.
45+
4246
Additional dependencies are fetched via CMake. For details see the `cmake` folder.
4347

4448
GoogleTest is used for testing.
@@ -92,8 +96,8 @@ using LaunchDarkly today!
9296
## Testing
9397

9498
We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test
95-
for consistency across SDKs. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all
96-
behave correctly.
99+
for consistency across SDKs. These tests cover each method in the SDK, and verify that event sending, flag evaluation,
100+
stream reconnection, and other aspects of the SDK all behave correctly.
97101

98102
## Contributing
99103

0 commit comments

Comments
 (0)