Skip to content

Commit 9f7c805

Browse files
README doc tweaks
1 parent 91ae4c0 commit 9f7c805

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ Chops Net IP:
3131

3232
The generated Doxygen documentation for `chops_net_ip` is [here](https://connectivecpp.github.io/chops-net-ip/).
3333

34-
## Dependencies
34+
## Library Dependencies
3535

36-
The stand-alone Asio library is a dependency for Chops Net IP. Specific version (or branch) specs for the Asio dependency is in `cmake/download_asio_cpm.cmake`.
36+
The stand-alone Asio library is a dependency for Chops Net IP. Specific version (or branch) specs for the Asio dependency is in [`cmake/download_asio_cpm.cmake`](cmake/download_asio_cpm.cmake).
3737

38-
The `shared_buffer` library from Connective C++ is a dependency, providing reference counted `std::byte` buffers.
38+
The [`shared_buffer`](https://github.com/connectivecpp/shared-buffer) library from Connective C++ is a dependency, providing reference counted `std::byte` buffers.
3939

40-
`expected_lite` from Martin Moene is a dependency, providing `std::expected` functionality for C++ 20 code baselines. Chops Net IP uses `nonstd::expected` in the codebase per Martin's library and will transition to `std::expected` when C++ 23 becomes the baseline.
40+
[`expected_lite`](https://github.com/martinmoene/expected-lite) from Martin Moene is a dependency, providing `std::expected` functionality for C++ 20 code baselines. Chops Net IP uses `nonstd::expected` in the codebase per Martin's library and will transition to `std::expected` when C++ 23 becomes the baseline.
4141

4242
## C++ Standard
4343

@@ -53,6 +53,10 @@ The unit test code uses [Catch2](https://github.com/catchorg/Catch2). If the `CH
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+
## Example Dependencies
57+
58+
(Fill in).
59+
5660
## Build and Run Unit Tests
5761

5862
To build and run the unit test programs:

0 commit comments

Comments
 (0)