Skip to content

README.md

Latest commit

 

History

History
59 lines (41 loc) · 1.89 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.89 KB

vkfetch-rs

CI

vkfetch-rs prints Vulkan GPU information with vendor ASCII art. It is a Rust rewrite of Wunkolo/vkfetch, with the original art ported and a few extra device capability fields.

Install

You need a Vulkan loader at runtime.

cargo install vkfetch-rs

Build

git clone https://github.com/float3/vkfetch-rs
cd vkfetch-rs
cargo build

The default build links against the Vulkan loader. Use the dynamic-loading feature when you want the binary to load Vulkan at runtime instead:

cargo build --no-default-features --features loaded

Nix users can enter a shell with the Vulkan loader, linker, rustup, and cargo-edit available:

nix develop

Development

The repository pins stable Rust with rustfmt and clippy in rust-toolchain.toml.

cargo fmt --all -- --check
cargo check --workspace --all-targets --all-features
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --workspace --all-targets --all-features
cargo check --workspace --all-targets --no-default-features --features loaded
RUSTDOCFLAGS="-D warnings" cargo doc --workspace --all-features --no-deps
nix flake check --print-build-logs

Useful maintenance commands:

cargo clippy --fix --workspace --all-targets --all-features --allow-dirty --allow-staged -- -D warnings
cargo upgrade -i
cargo update

Release

Bump package.version in Cargo.toml and keep Cargo.lock in sync with cargo update. After that bump lands on master or main, CI runs the Rust and Nix checks, creates tag vX.Y.Z, builds release executables with the dynamic-loading Vulkan feature, and publishes a GitHub release with generated release notes plus archives for Linux, Windows, and macOS.