From 59b9b0a5b41b9f5337f8ce77bdb74a4393a19a6a Mon Sep 17 00:00:00 2001 From: Antonis Geralis Date: Tue, 6 Sep 2022 11:44:36 +0300 Subject: [PATCH] readme add guidelines --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index e44caac..f072465 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,12 @@ proc byteSize(x: T): int {.inline.} ## The size that will be consumed by the ser This is only necessary for destructor-based types. `mutate`, `default` and `==` must also be defined. `drchaos/common` exports read/write procs that assist with this task. +### Dos and don'ts + +- Don't `echo` in a fuzz target as it slows down execution speed. +- Prefer `-d:danger` for maximum performance, once you have a crash you can always recompile with `-d:debug`. +- You could compile without sanitizers, AddressSanitizer slows down by 2x, but it's not recommended. + ### What's not supported - Polymorphic types, missing serialization support.