Skip to content

docs: document native build prerequisites for cargo install #3

Description

@andyleeboo

Problem

On a fresh Apple Silicon macOS environment, building pvcli from a checkout with:

cargo test --lib

reaches the native boring-sys dependency and fails when CMake is not installed:

failed to execute command: No such file or directory (os error 2)
is `cmake` not installed?

The documented cargo install --git https://github.com/cloudflareresearch/pvcli path uses the same native dependency, but the README currently does not call out its system build prerequisites. This can make a first install look like a Rust or pvcli failure rather than a missing native tool.

Suggested change

Add a short prerequisites section to the README covering:

  • a Rust toolchain
  • CMake
  • a C/C++ build toolchain
  • for macOS, an example such as Xcode Command Line Tools plus brew install cmake

I would be happy to send the small documentation PR if this direction looks right.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions