From cefff85a054d64f124aa1f3e91b9425695aa210b Mon Sep 17 00:00:00 2001 From: James O'Doherty Date: Fri, 22 May 2026 10:51:00 -0400 Subject: Update Makefile and README to standardize build/test process and lauch fuzzer --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'README.md') 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/`. -- cgit v1.2.3