hardware-tests/README.md
Gregory Ballantine a6f6994c2b
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
Added runtime req for iperf3
2024-01-28 19:59:31 -05:00

1.1 KiB

Bit Goblin Hardware Tests

Benchmarking suite used for testing hardware in Bit Goblin's videos.

Download & Installation

Check out the Releases page to find the latest compiled binaries.

Currently there is no installation method other than downloading the provided release binaries. In the future I want to build Linux package repositories for this, and have a Windows installer.

Running

Simply run the tool with ./bgbench and you'll be presented with the available subcommands.

Runtime requirements:

  • disk - requires fio.
  • network bandwidth - requires iperf3

Building

The easiest way to build the program is using the official Rust image from Docker Hub, for which there's a wrapper script at bin/docker-build.sh that can be used to build the test program. These will be available under target/debug/. Else you can just run a cargo build to compile the program.

License

The Bit Goblin hardware test suite is available via the BSD 2-Clause license, so feel free to hack away at it!