BitGoblin/hardware-tests
1
0
Fork 0
Code Issues 7 Pull Requests Projects Releases 11 Wiki Activity

Updated README
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details

Browse Source
This commit is contained in:
Gregory Ballantine 2022-08-05 21:47:42 -04:00
parent e39b78d5d7
commit 6f86266dee
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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