Getting started Install

Install

Grab a prebuilt release from GitHub and run --setup once, or build the compiler from source — it's a single Go module plus a small C++ runtime.

From a release

  1. Download the archive for your platform from the releases page and extract it.
  2. Run hover --setup once. It checks for a usable Zig toolchain and fixes it up if not: on Windows, it downloads one into ./toolchain/zig; on Linux, it reports whether one is already on PATH. See CLI reference.

Re-run it any time a compile fails with a "Zig not found" error.

From source

Building from source needs:

  • Go, to build the hover CLI itself.
  • Zig — no separate C++ toolchain needed. Every generated sim.cpp is compiled with zig c++, and the runtime library (which links against the bundled Eigen headers for its MNA solver) is built the same way. See Build targets.

This produces the hover binary. See the repository README for target-specific flags and make linux / make windows for packaging a standalone release.

Verify

Run it against any example under examples/ in the repository — see Example circuits — or jump straight to Your first circuit.