From 50375310300a983c9e1c65256b1946cc45c20b9f Mon Sep 17 00:00:00 2001 From: Julian Frimmel Date: Mon, 23 Sep 2024 16:52:26 +0200 Subject: [PATCH] Document platform support --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0c39508..12cb695 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,8 @@ Now the command line is `cargo valgrind `, where `` can be any You need to have `valgrind` installed and in the `PATH` (you can test this by running `valgrind --help` in your shell). You'll also need to have `cargo` installed and in the `PATH`, but since this is a cargo subcommand, you will almost certainly have it already installed. +Note, that this tool is only supported on platforms, that have `valgrind` available. +The code is built on MacOS and Linux on x86_64, but the tests are only run under Linux. ## Install the binary ### Use pre-built binaries