Add info on Debug flags

julia-vscode · Jul 28, 2020 · 6fc6e0c · 6fc6e0c
1 parent c9055ac
commit 6fc6e0c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,12 @@ Running x_plus_one.
 11
 ```
 
+### Flags
+
+For maximum performance in deployed software, you can disable all runtime assertions and debug code by setting this environment variable before building Salsa: `SALSA_STATIC_DEBUG=false`.
+
+Or, for slightly less peformance gain, you can toggle it at runtime via `Salsa.Debug.disable_debug()`.
+
 
 ## Credits
 This package was closely modelled off of the Rust