summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJames O'Doherty <james@theodohertyfamily.com>2026-05-22 10:51:00 -0400
committerJames O'Doherty <james@theodohertyfamily.com>2026-05-22 10:51:00 -0400
commitcefff85a054d64f124aa1f3e91b9425695aa210b (patch)
tree4ad2df3ba37a52ee246da327c310aabaecb2b896 /README.md
parent9131b0004e7c640cc028179e1d049a4c62210d94 (diff)
Update Makefile and README to standardize build/test process and lauch fuzzer
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0c493cb..90b243c 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,21 @@ make
```
This will compile the C launcher and embed it into the final `wg-wrap` binary.
+**Testing the Project:**
+The project uses a `Makefile` to orchestrate building and testing.
+- **Standard Tests**: Run the unit and integration tests:
+ ```bash
+ make test
+ ```
+- **Security Fuzzing**: Run the 8-bit clean argument integrity fuzzer:
+ ```bash
+ make fuzz
+ ```
+ You can adjust the fuzzer's parallelism and duration:
+ ```bash
+ FUZZ_PARALLEL=4 FUZZ_TIME=1h make fuzz
+ ```
+
## Profile Management
To simplify usage, `wg-wrap` implements a profile system for managing WireGuard configurations.
- **Storage**: Profiles are stored as standard `.conf` files in `~/.config/wg-wrap/profiles/`.