diff options
| author | Kamen Mladenov <kamen@syndamia.com> | 2025-02-26 17:08:35 +0200 |
|---|---|---|
| committer | Kamen Mladenov <kamen@syndamia.com> | 2025-02-26 17:10:12 +0200 |
| commit | 7cae7ec66ab2204572911b3f47342a703254f4e9 (patch) | |
| tree | 7cd11f5613975ddfc01029ef0ae14499b03408fc | |
| parent | 0cc9b7533d70900a8722ce5a6b3c754f0144831e (diff) | |
| download | zkVMs-benchmarks-7cae7ec66ab2204572911b3f47342a703254f4e9.tar zkVMs-benchmarks-7cae7ec66ab2204572911b3f47342a703254f4e9.tar.gz zkVMs-benchmarks-7cae7ec66ab2204572911b3f47342a703254f4e9.zip | |
docs(guest): Explain blacklisting feature
| -rw-r--r-- | guests/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
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. |