aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJP Appel <jeanpierre.appel01@gmail.com>2024-07-22 15:50:20 -0400
committerJP Appel <jeanpierre.appel01@gmail.com>2024-07-22 15:50:20 -0400
commit43148554ce0804e21de0ce66ee3d99beda70d797 (patch)
treeeb133872bacf8d4d82d44632cdab71f6b2086208
parent1ecaa7c5e4050d641bc8035f22386d533e51df15 (diff)
README updates
-rw-r--r--README.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/README.md b/README.md
index b7075b4..edc2d08 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ By default `make` builds all targets in `build/(static|dynamic|header)`
## Usage
EZ-Tester can be used as static, dynamic or header only library.
+Make sure to copy `eztester.h` somewhere in your include path.
After configuring your project, create a program to run your tests.
<details>
@@ -79,26 +80,33 @@ int main(int argc, char* argv[]){
After building, copy the static libraries into your project
```bash
-cp libeztester.a libeztester_debug.a $YOUR_PROJECT_DIRECORY/libs
+cp build/static/* $YOUR_PROJECT_DIRECORY/libs
```
When building make sure to add `-Llibs -leztester` to your linker flags
For example:
```bash
-gcc -o bird_tester tests/bird_tests.c src/bird.c -Llibs -leztester
+gcc -o tests test/test.c src/module.c -Llibs -leztester
```
-
### Dynamic
### Header
+To use the header-only implementation replace the include in your programs entry point to:
+
+```c
+#define EZTESTER_IMPLEMENTATION
+#include "eztester.h"
+#undef EZTESTER_IMPLEMENTATION
+```
+
## TODO
-* [ ] makefile
+* [x] makefile
* [x] static library target
* [x] dynamic library target
- * [ ] header-only target
+ * [x] header-only target
* [ ] colorized output
* [ ] `run_shell_script`