From 6f86266dee6e8495f2174aa1f81a18f1fc644b59 Mon Sep 17 00:00:00 2001 From: Gregory Ballantine Date: Fri, 5 Aug 2022 21:47:42 -0400 Subject: [PATCH] Updated README --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c58055a..f6d12c0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Bit Goblin Hardware Tests -Scripts used for testing hardware in Bit Goblin's videos. +Benchmarking suite used for testing hardware in Bit Goblin's videos. ## Download & Installation @@ -8,9 +8,16 @@ Check out the [Releases page](https://git.metaunix.net/BitGoblin/hardware-tests/ 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`. + ## 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 programs. These will be available under `target/debug/`. +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