aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index c452c95..e9d7f6e 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,7 @@ simple unit testing for C implemented as a single header file
brief summary
-------------
+
Your tests should be written as a single .c file separate from
the body of text containing your functionality to be tested.
Write the tests, include simple-test.h, point your compiler at
@@ -119,7 +120,7 @@ defined macros
| **ECHO(<...>)** | print a formatted description of the state within the current test |
| **ASSERT<_type_name><_condition>(<args>)** | assert, on either one or two `args` of type `_type_name`, that `_condition` is true |
-valid `_type_name`s and `_conditions` for ASSERT statements are:
+valid `_type_name` and `_condition` values for ASSERT statements are:
| **_type_name** | **DESCRIPTION** |
|---------------:|:----------------|
@@ -131,7 +132,7 @@ valid `_type_name`s and `_conditions` for ASSERT statements are:
| **_FLOAT** | operate on floating point types |
| **_PTR** | operate on generic pointer types. casts to void* |
| **_CHAR** | operate on args of type `char` |
-| **_STR** | operate on strings pointed to by args of type `char*`. |
+| **_STR** | operate on strings pointed to by args of type `char*`. |
| **_WCHAR** | operate on wide character types |
| **_WSTR** | operate on wide strings pointed to by args of type `wchar_t*` |
@@ -147,6 +148,6 @@ valid `_type_name`s and `_conditions` for ASSERT statements are:
note
----
-this makes heavy use of _Generic, so C11 support is required
-tested successfully both with gcc and clang
+this makes heavy use of _Generic, so C11 support is required
+tested successfully with both gcc and clang