Doc cleanup, third_party includes changes.

Author: cliffg-softwarelibre

.travis.yml

@@ -143,14 +143,11 @@ install:
 before_script:
 - cd ..
 - wget https://github.com/connectivecpp/utility-rack/archive/develop.tar.gz && mkdir utility-rack && tar -zxvf develop.tar.gz -C utility-rack --strip-components=1
-- wget https://github.com/martinmoene/expected-lite/archive/v0.3.0.tar.gz && mkdir expected-lite && tar -zxvf v0.3.0.tar.gz -C expected-lite --strip-components=1
 - wget https://github.com/chriskohlhoff/asio/archive/asio-1-14-0.tar.gz && mkdir asio && tar -zxvf asio-1-14-0.tar.gz -C asio --strip-components=1
 - wget https://github.com/catchorg/Catch2/archive/v2.10.2.tar.gz && mkdir Catch2 && tar -zxvf v2.10.2.tar.gz -C Catch2 --strip-components=1
-- wget https://github.com/martinmoene/ring-span-lite/archive/v0.3.0.tar.gz && mkdir ring-span-lite && tar -zxvf v0.3.0.tar.gz -C ring-span-lite --strip-components=1
-- wget https://github.com/JustasMasiulis/circular_buffer/archive/master.tar.gz && mkdir circular_buffer && tar -zxvf master.tar.gz -C circular_buffer --strip-components=1
 - mkdir build && cd build
 - cmake ../chops-net-ip/
 
 script:
 - make all -j2
-- make test
+- make test

README.md

@@ -6,10 +6,12 @@ Branch | Status
 
 # Chops Net IP - Connective Handcrafted Openwork Software for Asynchronous IP Networking
 
-Chops Net IP is a C++ library that makes asynchronous networking programming fun. Or at least if not fun, it makes network programming easier and safer, without significantly sacrificing performance. It is layered on top of the Asio asynchronous networking library, which can be difficult to use correctly. It handles Internet Protocol (IP) communications including TCP, UDP, and UDP multicast. It is written using modern C++ design idioms and the latest (2017) C++ standard.
+Chops Net IP is a C++ library that makes asynchronous networking programming fun. Or at least if not fun, it makes network programming easier and safer, without significantly sacrificing performance. Chops Net IP handles Internet Protocol (IP) communications including TCP, UDP, and UDP multicast. It is written using modern C++ design idioms and the latest (2017) C++ standard.
 
 Chops Net IP is not like any other high-level, general purpose C++ socket library.
 
+Chops Net IP is layered on top of the Asio asynchronous networking library, taking advantage of the portability and functionality that Asio provides. However, it simplifies network programming compared to coding against the Asio API, while providing easy scalability through the asynchronous facilities.
+
 # License
 
 [![Licence](https://img.shields.io/badge/license-boost-4480cc.svg)](http://www.boost.org/LICENSE_1_0.txt)
@@ -18,7 +20,7 @@ This project is distributed under the [Boost Software License](LICENSE.txt).
 
 ## Chops Net IP Release Status
 
-Release 1.0 is under development as of October 2019, awaiting CMake config file completion, a comprehensive tutorial, and additional testing under multiple compilers and platforms.
+Release 1.0 is under development as of January 2020, awaiting CMake enhancements, a comprehensive tutorial, and additional testing under multiple compilers and platforms.
 
 Release notes and upcoming development plans are [available here](doc/release.md).
 
@@ -91,15 +93,18 @@ All the dependencies listed below have links that will take you to the library o
 
 Production external dependencies:
 
-- Version 1.13 (or later) of Chris Kohlhoff's [`asio`](https://github.com/chriskohlhoff/asio) library is required. Note that it is the stand-alone library, not the Boost Asio implementation.
-- Version 0.9 (or later) of the [`utility-rack`](https://github.com/connectivecpp/utility-rack) library, which is a repository in the same GitHub account as Chops Net IP (`shared_buffer.hpp`, `erase_where.hpp`, `overloaded.hpp`, and `cast_ptr_to` are required).
-- Version 0.3 (or later) of Martin Moene's [`expected-lite`](https://github.com/martinmoene/expected-lite) library.
+- Version 1.13 (or later) of Chris Kohlhoff's [`asio`](https://github.com/chriskohlhoff/asio) library is required. Note that it is the stand-alone Asio library, not the Boost Asio version.
+- The [`utility-rack`](https://github.com/connectivecpp/utility-rack) library, which is a repository in the same GitHub account as Chops Net IP.
 
 Test external dependencies:
 
 - Version 2.8.0 (or later) of Phil Nash's [`Catch2`](https://github.com/catchorg/Catch2) library is required for all test scenarios.
 
-See [References](doc/references.md) for additional details on the above libraries.
+There are single file headers that have been copied into the `third_party` directory of the `utility-rack` repository from various GitHub repositories and do not require any external dependency management. These are:
+
+- Martin Moene's [`expected-lite`](https://github.com/martinmoene/expected-lite) library.
+
+See [References](doc/references.md) for additional details.
 
 # Supported Compilers and Platforms
 
@@ -108,6 +113,8 @@ Chops Net IP has been compiled and tests run on:
 - g++ 7.2, g++ 7.3, Linux (Ubuntu 17.10 - kernel 4.13, Ubuntu 18.04 - kernel 4.15)
 - (TBD, will include at least clang on linux and vc++ on Windows)
 
+Follow the CI links for additional build environments.
+
 # Installation
 
 Chops Net IP is header-only, so installation consists of downloading or cloning and setting compiler include paths appropriately. No compile time configuration macros are defined.
@@ -118,9 +125,5 @@ See [References](doc/references.md) for details on dependencies and inspirations
 
 # About
 
-The primary author of Chops is Cliff Green, cliffg at connectivecpp dot com. The primary co-author is Thurman Gillespy, thurmang at connectivecpp dot com, and Roxanne Agerone roxannea at connectivecpp dot com.
-
-Collaborators include Roxanne Agerone and Nathan Deutsch.
-
-Additional information including author comments is [available here](doc/about.md).
+Team member information is [available here](https://connectivecpp.github.io/), and a few random author comments are [available here](doc/about.md).
 

doc/about.md

@@ -1,14 +1,8 @@
 # Author Notes and Contributor Information
 
-The primary author of Chops Net IP is Cliff Green, cliffg at connectivecpp dot com. Cliff is a software engineer and has worked for many years writing infrastructure libraries and applications for use in networked and distributed systems, typically where high reliability or uptime is required. The domains where he has worked include wireless networks (in particular cellular 9-1-1), location technology, and large scale embedded and simulation systems in the military aerospace industry. He has volunteered every year at CppCon and presented at BoostCon (before it was renamed to C++ Now).
-
-Cliff lives in the Seattle area and you may know him from other interests including volleyball, hiking, railroading (both the model variety and the real life big ones), music, or even parent support activities (if you are having major difficulties with your teen check out the Changes Parent Support Network, http://cpsn.org).
-
-The primary co-author of Chops Net IP is Thurman Gillespy, thurmang at connectivecpp dot com. Thurman's first career was in diagnostic radiology, with stints at the University of Florida (1985 - 1990), University of Washington (1990 - 2008) and private practice in Seattle (2008 - 2015). In the 1990's, Thurman wrote Dr Razz, the first application that could display and manipulate radiology images on a Macintosh computer. In 2015 Thurman left medicine and went back to school to transform a life long hobby of programming into a second career as a software developer.
-
 ## A Cliff Note on the Chops Name
 
->Yes, the name / acronym is a stretch. Quite a stretch. I like the word "chops", which is a jazz term for strong technique, so I decided on that for a name. For example, "Check out Tal Wilkenfeld, she's got mad chops."
+>(from Cliff, 2018) Yes, the name / acronym is a stretch. Quite a stretch. I like the word "chops", which is a jazz term for strong technique, so I decided on that for a name. For example, "Check out Tal Wilkenfeld, she's got mad chops."
 
 >I considered many names, at least two or three dozen, but my favorite ideas were all taken (or too close to existing names and could create confusion). It seems that a lot of software developers have similar creative ideas when it comes to names.
 

doc/release.md

@@ -2,7 +2,7 @@
 
 ## Release 1.0
 
-Release 1.0 is under development, expected in late summer of 2019. Additional platform and compiler testing is under way, in-depth tutorials are under development, a few minor features are under development, and the marshalling library needs to be completed.
+Release 1.0 is under development, expected in the first part of 2020. Additional platform and compiler testing is under way, in-depth tutorials are under development, and the marshalling library in the `utility-rack` repository needs to be completed.
 
 ## Release 0.3
 

example/CMakeLists.txt

@@ -31,18 +31,17 @@ set ( header_dirs
 # Still learning find_package and related ways to bring in third party dependent include directories,
 # so don't judge, instead please help.
 
-set ( utility_rack_include_dir "${CMAKE_SOURCE_DIR}/../utility-rack/include" )
+set ( utility_rack_include_dir
+     "${CMAKE_SOURCE_DIR}/../utility-rack/include"
+     "${CMAKE_SOURCE_DIR}/../utility-rack/third_party"
+    )
 if ( NOT $ENV{UTILITY_RACK_INCLUDE_DIR} STREQUAL "" )
     set ( utility_rack_include_dir $ENV{UTILITY_RACK_INCLUDE_DIR}} )
 endif()
 set ( asio_include_dir "${CMAKE_SOURCE_DIR}/../asio/asio/include" )
 if ( NOT $ENV{ASIO_INCLUDE_DIR} STREQUAL "" )
     set ( asio_include_dir $ENV{ASIO_INCLUDE_DIR}} )
 endif()
-set ( expected_lite_include_dir "${CMAKE_SOURCE_DIR}/../expected-lite/include" )
-if ( NOT $ENV{EXPECTED_LITE_INCLUDE_DIR} STREQUAL "" )
-    set ( expected_lite_include_dir $ENV{EXPECTED_LITE_INCLUDE_DIR}} )
-endif()
 
 function ( add_target_dependencies target )
 #    find_package ( utility-rack REQUIRED )
@@ -51,9 +50,6 @@ function ( add_target_dependencies target )
 #    find_package ( asio REQUIRED )
 #    target_include_directories ( ${target} PRIVATE ${asio_INCLUDE_DIRS} )
     target_include_directories ( ${target} PRIVATE ${asio_include_dir} )
-#    find_package ( expected-lite REQUIRED )
-#    target_include_directories ( ${target} PRIVATE ${expected-lite_INCLUDE_DIRS} )
-    target_include_directories ( ${target} PRIVATE ${expected_lite_include_dir} )
 endfunction()
 
 function ( add_target_info target )

example/README.md

@@ -31,7 +31,6 @@ The following dependencies are required to build the example apps (an additional
 
 * [Asio](https://github.com/chriskohlhoff/asio)
 * [Utility Rack](https://github.com/connectivecpp/utility-rack)
-* [Expected Lite](https://github.com/martinmoene/expected-lite)
 
 # Building and Running Individual Example Apps
 
@@ -54,17 +53,17 @@ g++ on pc or linux:
 g++ -std=c++17 -Wall -Werror\
 -I ../include \
 -I <path to utility rack>/include/ \
+-I <path to utility rack>/third_party/ \
 -I <path to Asio>/include/ \
--I <path to expected-lite>/include/ \
 simple_chat_demo.cpp -lpthread -o chat_server
 ```
 Build the example with g++ or clang++ on OSX:
 ```
 g++ -std=c++17 -Wall -Werror -Wno-unused-lambda-capture \
 -I ../include \
 -I <path to utility rack>/include/ \
+-I <path to utility rack>/third_party/ \
 -I <path to Asio>/include/ \
--I <path to expected-lite>/include/ \
 simple_chat_demo.cpp -lpthread -o chat_server
 ```
 
@@ -100,17 +99,17 @@ g++ or clang++ on pc or linux:
 g++ -std=c++17 -Wall -Werror \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
 echo_binary_text_client_demo.cpp -lpthread -o echo_client
 ```
 build with clang++ or g++ on OSX:
 ```
 g++ -std=c++17 -Wall -Werror -Wno-unused-lambda-capture \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
 echo_binary_text_client_demo.cpp -lpthread -o echo_client
 ```
 3. Execute the file:
@@ -149,17 +148,17 @@ with g++ on pc or linux:
 g++ -std=c++17 -Wall -Werror \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
 echo_binary_text_server_demo.cpp -lpthread -o echo_server
 ```
 Build the example with g++ or clang++ on OSX:
 ```
 g++ -std=c++17 -Wall -Werror -Wno-unused-lambda-capture \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
 echo_binary_text_server_demo.cpp -lpthread -o echo_server
 ```
 3. Execute the file:
@@ -194,17 +193,17 @@ cd <path>/chops-net-ip/example
  g++ -std=c++17 -Wall -Werror \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
  local_echo_demo.cpp -lpthread -o local_echo
  ```
 Build the example with g++ or clang++ on OSX:
  ```
  g++ -std=c++17 -Wall -Werror -Wno-unused-lambda-capture \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
  local_echo_demo.cpp -lpthread -o local_echo
  ```
  3. Execute the file
@@ -231,17 +230,17 @@ cd <path>/chops-net-ip/example
  g++ -std=c++17 -Wall -Werror \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
  simple_chat_demo.cpp -lpthread -o chat
  ```
 Build the example with g++ or clang++ on OSX:
  ```
  g++ -std=c++17 -Wall -Werror -Wno-unused-lambda-capture \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
  simple_chat_demo.cpp -lpthread -o chat
  ```
  3. Execute the file
@@ -286,17 +285,17 @@ cd <path>/chops-net-ip/example
  g++ -std=c++17 -Wall -Werror \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
  udp_broadcast_demo.cpp -lpthread -o udp_broad
  ```
 Build the example with g++ or clang++ on OSX:
  ```
  g++ -std=c++17 -Wall -Werror -Wno-unused-lambda-capture \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
  udp_broadcast_demo.cpp -lpthread -o udp_broad
  ```
  3. Execute the file
@@ -339,17 +338,17 @@ cd <path>/chops-net-ip/example
  g++ -std=c++17 -Wall -Werror \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
 udp_receiver_demo.cpp -lpthread -o udp_receive
  ```
 Build the example with g++ or clang++ on OSX:
  ```
  g++ -std=c++17 -Wall -Werror -Wno-unused-lambda-capture \
 -I ../include \
 -I <path>/utility-rack/include/ \
+-I <path>/utility-rack/third_party/ \
 -I <path>/asio/asio/include/ \
--I <path>/expected-lite/include/ \
  udp_receiver_demo.cpp -lpthread -o udp_receive
  ```
  3. Execute the file

test/CMakeLists.txt

@@ -56,18 +56,17 @@ set ( catch2_include_dir "${CMAKE_SOURCE_DIR}/../Catch2/single_include" )
 if ( NOT $ENV{CATCH2_INCLUDE_DIR} STREQUAL "" )
     set ( catch2_include_dir $ENV{CATCH2_INCLUDE_DIR}} )
 endif()
-set ( utility_rack_include_dir "${CMAKE_SOURCE_DIR}/../utility-rack/include" )
+set ( utility_rack_include_dir
+    "${CMAKE_SOURCE_DIR}/../utility-rack/include"
+    "${CMAKE_SOURCE_DIR}/../utility-rack/third_party"
+    )
 if ( NOT $ENV{UTILITY_RACK_INCLUDE_DIR} STREQUAL "" )
     set ( utility_rack_include_dir $ENV{UTILITY_RACK_INCLUDE_DIR}} )
 endif()
 set ( asio_include_dir "${CMAKE_SOURCE_DIR}/../asio/asio/include" )
 if ( NOT $ENV{ASIO_INCLUDE_DIR} STREQUAL "" )
     set ( asio_include_dir $ENV{ASIO_INCLUDE_DIR}} )
 endif()
-set ( expected_lite_include_dir "${CMAKE_SOURCE_DIR}/../expected-lite/include" )
-if ( NOT $ENV{EXPECTED_LITE_INCLUDE_DIR} STREQUAL "" )
-    set ( expected_lite_include_dir $ENV{EXPECTED_LITE_INCLUDE_DIR}} )
-endif()
 
 function ( add_target_dependencies target )
 #    find_package ( utility-rack REQUIRED )
@@ -79,9 +78,6 @@ function ( add_target_dependencies target )
 #    find_package ( asio REQUIRED )
 #    target_include_directories ( ${target} PRIVATE ${asio_INCLUDE_DIRS} )
     target_include_directories ( ${target} PRIVATE ${asio_include_dir} )
-#    find_package ( expected-lite REQUIRED )
-#    target_include_directories ( ${target} PRIVATE ${expected-lite_INCLUDE_DIRS} )
-    target_include_directories ( ${target} PRIVATE ${expected_lite_include_dir} )
 endfunction()
 
 function ( add_target_info target )