Skip to content

Commit 51b9ef9

Browse files
committed
Documentation update
1 parent 44949ec commit 51b9ef9

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ An integration test framework used for testing multi-threaded C++ based projects
1313
- [Overview](#overview)
1414
- [References](#references)
1515
- [Getting Started](#getting-started)
16-
- [Logger Subsystem](#logger-subsystem)
1716
- [Source Code](#source-code)
17+
- [Logger Subsystem](#logger-subsystem)
1818
- [Testing Strategy](#testing-strategy)
1919
- [Delegates](#delegates)
2020
- [Integration Tests](#integration-tests)
@@ -54,6 +54,16 @@ This project implements an integration testing framework for multi-threaded C++
5454
`cmake -B Build . -DENABLE_IT=ON`
5555
3. Build and run the project within the `Build` directory.
5656

57+
# Source Code
58+
The project contains the following directories:
59+
60+
* **DelegateMQ** - the DelegateMQ library source code directory
61+
* **GoogleTest** - the Google Test library source code directory
62+
* **IntegrationTest** - the integration test framework source code
63+
* **Logger/it** - the Logger subsystem integration test source code
64+
* **Logger/src** - the Logger subsystem production source code
65+
* **Port** - supporting utilities source code files
66+
5767
# Logger Subsystem
5868
A simple string logging subsystem is used to illustrated the integration test concepts. The `Logger` class is the subsystem public interface. `Logger` executes in its own thread of control. The `Write()` API is thread-safe.
5969

@@ -79,15 +89,7 @@ public:
7989
8090
The goal of the project is to provide an integration test framework with a simple example of testing the `Logger` subsystem in a multi-threaded environment.
8191
82-
# Source Code
83-
The project contains the following directories:
8492
85-
* **DelegateMQ** - the DelegateMQ library source code directory
86-
* **GoogleTest** - the Google Test library source code directory
87-
* **IntegrationTest** - the integration test framework source code
88-
* **Logger/it** - the Logger subsystem integration test source code
89-
* **Logger/src** - the Logger subsystem production source code
90-
* **Port** - supporting utilities source code files
9193
9294
# Testing Strategy
9395
Software systems are complex, with numerous library and file dependencies, making integration testing challenging. It can be difficult to isolate and test a subsystem that consists of dozens or even hundreds of source files. This complexity is further compounded when the source code is intended to run only on an embedded target. While unit tests can isolate individual modules, integration testing increases complexity exponentially.

0 commit comments

Comments
 (0)