diff options
| author | JP Appel <jeanpierre.appel01@gmail.com> | 2024-07-21 14:40:09 -0400 |
|---|---|---|
| committer | JP Appel <jeanpierre.appel01@gmail.com> | 2024-07-21 14:40:09 -0400 |
| commit | da6877b8be4ecd6a27e076766bf0b6b6f02959cd (patch) | |
| tree | c8ca7352955289c96239255a99774967a3f1e9be /README.md | |
| parent | db97c4a08b5dfa1c20e7239e9aa4226f0f0235fe (diff) | |
FEAT/DOC: add static target, build/usage instructions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 36 insertions, 0 deletions
@@ -2,6 +2,42 @@ A barebones testing library for C +## Build + +Note this has only been tested on my machine + +* Void Linux x86_64 glibc + +```bash +make static # builds libeztester.a and libeztester_debug.a +``` + +### Dependencies + +* None ☺️ + +## Usage + +### Static + +After building, copy the static libraries into your project + +```bash +cp libeztester.a libeztester_debug.a $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 +``` + + +### Dynamic + +### Header + ## TODO * [ ] makefile |
