From 7cae7ec66ab2204572911b3f47342a703254f4e9 Mon Sep 17 00:00:00 2001 From: Kamen Mladenov Date: Wed, 26 Feb 2025 17:08:35 +0200 Subject: docs(guest): Explain blacklisting feature --- guests/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'guests') diff --git a/guests/README.md b/guests/README.md index 9afcc23..161365c 100644 --- a/guests/README.md +++ b/guests/README.md @@ -139,3 +139,15 @@ You may execute/prove/verify a program in this directory (when the repository is ```sh nix run .#YOUR_PROJECT prove ``` + +It is highly possible your program will not be compatible with a certain zkVM. +You may either fix the issue, or blacklist the zkVM. + +## Blacklisting + +You may add files in the form `.no_ZKVM` to the `guest/YOUR_PROJECT` directory. +The existance of one will disallow building your guest program with the zkVM. + +You'll still get an output from the Nix package, however it will be a trivial script, which prints a warning message. + +If `.no_ZKVM` contains text, the contents will be printed alongside the warning. -- cgit v1.2.3