diff --git a/BUILD.md b/BUILD.md index 0720677dd3a7..8e22c44d6c3c 100644 --- a/BUILD.md +++ b/BUILD.md @@ -31,6 +31,12 @@ If you are using an Apple-silicon Mac (M1, M2), make sure `rustc -vV` outputs `h rustup set default-host aarch64-apple-darwin && rustup install 1.79.0 ``` +## Validating your environment +You can validate your environment is set up correctly by running: +```sh +pixi run check-env +``` + ## Building and running the Viewer diff --git a/pixi.toml b/pixi.toml index 82b42fa3db58..23dab9c194e4 100644 --- a/pixi.toml +++ b/pixi.toml @@ -9,6 +9,11 @@ # # https://prefix.dev/docs/pixi/overview +# We currently assume pixi version 0.34.0 +# You can check that your environment is correct by running: +# - python scripts/check_env.py +# - pixi run check-env + [project] name = "rerun" authors = ["rerun.io "] @@ -114,6 +119,9 @@ examples-pypi = ["examples-common", "python-pypi"] [tasks] # Note: extra CLI argument after `pixi run TASK` are passed to the task cmd. +# Check that your environment is set up correctly +check-env = "python scripts/check_env.py" + # Run the codegen. Optionally pass `--profile` argument if you want. codegen = "cargo --quiet run --package re_types_builder -- "