Skip to content

Commit d215412

Browse files
committed
Added more information on how to use the framework.
1 parent 9eef32f commit d215412

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
![](header_image.jpg)
44

5+
## Features
6+
57
This unit test framework provides a variety of features in a single library, including:
68
* Testing for success with CHECK_TRUE, CHECK_EQUAL, etc.
79
* Identify tests as functions, member functions and const member functions.
@@ -13,9 +15,15 @@ This unit test framework provides a variety of features in a single library, inc
1315
* Provide custom logging (replace stdio output).
1416
* Test for C++ exceptions.
1517

18+
## How to use
19+
20+
Copy the `test` folder into any location and include `Test.hpp` from the test folder
21+
1622
## Code Examples
1723

1824
```cpp
25+
#include "test/Test.hpp"
26+
1927
TEST(MyTest)
2028
{
2129
int a = 1;

0 commit comments

Comments
 (0)