Skip to content

Commit ffb9cd3

Browse files
update README noting this is now a library only project and concrete examples have moved.
1 parent 4698687 commit ffb9cd3

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CppUTest for the QP/C (qpc) Real-Time Embedded Framework
1+
# CppUTest for the QP/C (qpc) Real-Time Embedded Framework (library only)
22

33
Build and Test status: ![Build and Tests](https://github.com/covemountainsoftware/cpputest-for-qpc/actions/workflows/cmake.yml/badge.svg)
44

@@ -12,7 +12,7 @@ encourage and support efforts like this. Thank you!
1212

1313
# Introduction
1414

15-
The `cpputest-for-qpc` project enables CppUTest for the
15+
The `cpputest-for-qpc` library project enables CppUTest for the
1616
QP/C Real-Time Embedded Framework. This project provides for the
1717
following capabilities:
1818

@@ -22,7 +22,7 @@ following capabilities:
2222
* Supporting utilities to simplify unit testing of qpc
2323
based active objects. Provided classes may also be useful in
2424
the final target software, if C++ is also in use.
25-
* An example C language based active object under test.
25+
* A separate examples project providing usage/examples of this library
2626

2727
Benefits of this approach to unit testing active objects include:
2828
* No surprises. The active object under test interacts with the
@@ -43,13 +43,15 @@ Benefits of this approach to unit testing active objects include:
4343

4444
# Environment
4545

46-
This project was developed and proven in Ubuntu 20.04. In theory any
46+
This project was developed and proven in Ubuntu 20.04 and 22.04. In theory any
4747
build or host operating system environment supported by CppUTest will
4848
be compatible with this code.
4949

5050
## Prerequisites
5151

52-
* qpc (pulled in as a git submodule)
52+
* qpc
53+
* You can override the QPC to another directory with your project's exact QPC source code.
54+
* or:
5355
* After cloning this repository, do not forget to:
5456
* `git submodule init`
5557
* `git submodule update`
@@ -125,7 +127,7 @@ behavior, using the exact same interfaces the active object would use
125127
in the production target. CppUTest provides for the mocking capabilities to
126128
ensure that the active object under test is calling the expected APIs.
127129

128-
Within this project, please see the tests for `examples/hwLockCtrlService` which
130+
Within the associated examples project, please see the tests for `examples/hwLockCtrlService` which
129131
provides examples of:
130132
* Testing for reaction to a published event, where the reaction is observed
131133
through a CppUTest `mock()`.

0 commit comments

Comments
 (0)