From 2f3cb7c11919d94e5913858b2e095c6cd15a8a6c Mon Sep 17 00:00:00 2001 From: Uwe McVogt Date: Sun, 10 Sep 2023 14:25:04 +0200 Subject: [PATCH] Update README --- README.md | 4 ++++ Tests/CANAPI/GoogleTest/README.txt | 36 ++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100755 Tests/CANAPI/GoogleTest/README.txt diff --git a/README.md b/README.md index ff92b5e..0071132 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,10 @@ General test settings can be adapted in the file `Settings.h`. ## This and That +### CAN API V3 Reference + +A generic documentation of the CAN API V3 application programming interface can be found [here](https://uv-software.github.io/CANAPI-Docs). + ### Wrapper Library for Windows® A CAN API V3 compatible Wrapper Library for Windows is also available. diff --git a/Tests/CANAPI/GoogleTest/README.txt b/Tests/CANAPI/GoogleTest/README.txt new file mode 100755 index 0000000..3d18a79 --- /dev/null +++ b/Tests/CANAPI/GoogleTest/README.txt @@ -0,0 +1,36 @@ +Google Test Framework (GoogleTest) for CAN API V3 C++ Testing +============================================================= + +GoogleTest (aka gtest) is a unit testing library for the C++ programming language, +released under the BSD 3-clause license and based on the xUnit architecture. + +CAN API V3 is a wrapper specification to have a multi-vendor, cross-platform CAN API. +GoogleTest is used for testing of CAN API V3 C++ wrapper implementations. + +Source Code Repositiory of GoogleTest +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +URL: https://github.com/google/googletest + +Current Version used by CAN API V3 C++ Testing +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +v1.12.0 (https://github.com/google/googletest/releases/tag/v1.12.0) + +Installation and Usage of GoogleTest +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +1. Clone the GoogleTest main branch or download the sources from a tag + e.g. into '~/Projects/gtest' +2. Copy all header files from '~/Projects/gtest\googletest\include' + into '$(PROJROOT)/Tests/CANAPI/GoogleTest/include' +3. Build static libraries as Universal macOS Binary for macOS 11.0 with CMake + note: GoogleMock (aka gmock) does not need to be created for this project. +4. Copy all files from '~/Projects/gtest/googletest/build/lib' + into '$(PROJROOT)/Tests/CANAPI/GoogleTest/macOS/lib' + +Important Notes +~~~~~~~~~~~~~~~ +- Adapt the architecture and deployment settings according to the root project +- Since version 1.13.x Googletest requires at least C++14 + +Last Updated +~~~~~~~~~~~~ +August 24, 2023