From 6fdd791f03166ba6a315bdac56754d93b062a0ce Mon Sep 17 00:00:00 2001 From: Robert Sesek Date: Sat, 8 Oct 2016 18:17:18 -0400 Subject: [PATCH] Add a Suggested Usage section to the README. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 52f6893..571a611 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,10 @@ can be poisoned against future use. When the tracking option is disabled and compiler optimization is turned up, the cost of using zcpointer is none, compared to using a normal `unique_ptr`. + +## Suggested Usage + +When using zcpointer, it is recommended to compile with `ZCPOINTER_TRACK_REFS` for debug builds, or +if your project provides a hardened compilation mode (such as `_FORTIFY_SOURCE`). For production +builds, turn off reference tracking to eliminate the overhead of zcpointer. Tests should be run +using `ZCPOINTER_TRACK_REFS=1` to catch errors during development. -- 2.22.5