hardware-tests/README.md

# Bit Goblin Hardware Tests

Scripts used for testing hardware in Bit Goblin's videos.

## Download & Installation

Check out the [Releases page](https://git.metaunix.net/BitGoblin/hardware-tests/releases) 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.

## 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/`.

## License

The Bit Goblin hardware test suite is available via the BSD 2-Clause license, so feel free to hack away at it!
Updated the README; added copyright info to LICENSE file 2022-08-05 17:29:05 -04:00			`# Bit Goblin Hardware Tests`
Initial commit 2022-02-24 20:11:37 -05:00
Updated the README; added copyright info to LICENSE file 2022-08-05 17:29:05 -04:00			`Scripts used for testing hardware in Bit Goblin's videos.`

			`## Download & Installation`

			`Check out the [Releases page](https://git.metaunix.net/BitGoblin/hardware-tests/releases) 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.`

			`## 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/`.

			`## License`

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