fix readme and add test instructions

Signed-off-by: Aidan Hahn <aidan@aidanis.online>
This commit is contained in:
Aidan Hahn 2022-03-07 11:40:22 -08:00
parent ca1e2e3453
commit 9ee1aacd83
No known key found for this signature in database
GPG key ID: 327711E983899316
2 changed files with 5 additions and 3 deletions

View file

@ -19,7 +19,7 @@ ALOG_LIB = $(TARGET_DIR)/alog.so
include $(dir $(lastword $(MAKEFILE_LIST)))tests/tests.mk
.PHONY: so
.PHONY: alog-so
alog-so: $(if $(shell stat $(ALOG_LIB)), clean) $(ALOG_LIB)
$(ALOG_LIB): $(TARGET_DIR) $(ALOG_OBJ)

View file

@ -17,14 +17,16 @@ Anything that is a file descriptor and can be written to with write() and fsync(
# How to build
```bash
$ make so
$ make alog-so
```
# How to test
```
$ make alog-tests
```
# Variables
The following (shell) variables can be set to influence behavior at runtime:
The following (shell) variables can be set at compile time:
- **ALOG_DEBUG**: Set this variable to compile with debug symbols
- **ALOG_HIJACK_PRINTF**: Set this variable to compile along with a printf implementation that leverages alog. Probably dont though.