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
- Download the archive for your platform from the releases page and extract it.
- Run
hover --setuponce. 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 onPATH. 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
hoverCLI itself. - Zig — no separate C++ toolchain needed. Every generated
sim.cppis compiled withzig 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.