Skip to content

Commit d713b1c

Browse files
Readme update to enumerate the examples provided by this repo
1 parent b1ce619 commit d713b1c

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,32 @@ key benefits of host-based testing of embedded software.
4343

4444
See the configuration at: `.github/workflows/cmake.yml`
4545

46-
# Testing Support
46+
# Examples
47+
48+
## Button Service
49+
50+
The button service is effectively an active object style FreeRTOS service (thread)
51+
which blocks exclusively on a semaphore. It is provided as an example of
52+
how to use this library to unit test a thread that pends on a semaphore.
53+
54+
See `example/services/buttonService/test` for the associated unit tests.
55+
56+
## Hw Lock Ctrl Service
57+
58+
The Hw Lock Ctrl Service is a traditional active object FreeRTOS service (thread)
59+
which blocks exclusively on a queue. It is provided as an example of
60+
how to use this library to unit test an active object thread.
61+
62+
See `example/services/hwLockCtrlService/test` for the associated unit tests.
63+
64+
## demoPcApp
65+
66+
A POSIX port FreeRTOS demonstration app interacting with the example services in a
67+
real FreeRTOS environment.
68+
69+
See `example\apps\demoPcApp`.
70+
71+
# FreeRTOS Support
4772

4873
## Tasks
4974

0 commit comments

Comments
 (0)