document dependency on Boost.Endian

boostorg · Feb 13, 2024 · 3db8f18 · 3db8f18
1 parent 5663210
commit 3db8f18
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -95,6 +95,10 @@ building the library or including the function definitions:
 #define BOOST_JSON_STACK_BUFFER_SIZE 1024
 #include <boost/json/src.hpp>
 ```
+### Endianness
+
+Boost.JSON uses [Boost.Endian](https://www.boost.org/doc/libs/release/libs/endian/doc/html/endian.html)
+in order to support both little endian and big endian platforms.
 
 ### Supported Compilers
 

diff --git a/doc/qbk/overview.qbk b/doc/qbk/overview.qbk
@@ -120,6 +120,12 @@ building the library or including the function definitions:
 #include <boost/json/src.hpp>
 ```
 
+[heading Endianness]
+
+Boost.JSON uses
+[@https://www.boost.org/doc/libs/release/libs/endian/doc/html/endian.html
+Boost.Endian] in order to support both little endian and big endian platforms.
+
 [heading Supported Compilers]
 
 Boost.JSON has been tested with the following compilers: