Merge pull request #230 from gregmedd/release/1.0.0/documentation-cle…

…anup

Documentation cleanup

NOTICE.adoc

@@ -27,10 +27,5 @@ SPDX-License-Identifier: Apache-2.0
 
 The following are libraries used by this project:
 
-* http://cloudevents.io
-* https://github.com/google/googletest
 * http://protobuf.dev
-* https://github.com/openssl/openssl
-* https://github.com/topics/libuuid
-* https://github.com/Tencent/rapidjson
-* https://github.com/cgreen-devs/cgreen
+* https://github.com/google/googletest

README.md

@@ -1,5 +1,7 @@
 # uProtocol C++ Interface Library (up-cpp)
 
+[![Build & Test](https://github.com/eclipse-uprotocol/up-cpp/actions/workflows/ci.yml/badge.svg?branch=v1.0_up-v1.6.0)](https://github.com/eclipse-uprotocol/up-cpp/actions/workflows/ci.yml)
+
 ## Welcome!
 
 This library provides the primary interface to uProtocol for uEntity
@@ -56,30 +58,38 @@ up-cpp, If you are making a project that uses up-cpp, follow the steps in the
 
 ### With Conan for dependencies
 
-Clone the up-cpp repo to a folder named: up-cpp
+From the root of this repo, run:
 
-```
-cd up-cpp
-conan install .
-cd build
-cmake ../ -DCMAKE_TOOLCHAIN_FILE=Release/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release
+```bash
+conan install --build=missing .
+cmake --preset conan-release
+cd build/Release
 cmake --build . -- -j
 ```
 
 Once the build completes, tests can be run with `ctest`.
 
-### Generate UT  Coverage
+Debug builds can be generated by changing those steps to:
 
-To get code coverage, perform the steps above, but use the following cmake line instead
+```bash
+conan install --build=missing --settings=build_type=Debug .
+cmake --preset conan-debug
+cd build/Debug
+cmake --build . -- -j
 ```
-cmake ../ -DCMAKE_TOOLCHAIN_FILE=Release/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Coverage
+
+### Generate UT Coverage
+
+To get code coverage, perform the steps above, but replace `cmake --preset...` with
+```
+cd build/Release
+cmake ../../ -DCMAKE_TOOLCHAIN_FILE=generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Coverage
 ```
 Once the tests complete, the Unit Test Coverage report can be generated from the base up-cpp folder with: ./Coverage.sh
 ```
 ./coverage.sh
 ```
 
-
 ### With dependencies installed as system libraries
 
 **TODO** Verify steps for pure cmake build without Conan.