Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mac-can committed Sep 10, 2023
1 parent ab4ddf0 commit 2f3cb7c
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -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.
Expand Down
36 changes: 36 additions & 0 deletions 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

0 comments on commit 2f3cb7c

Please sign in to comment.