From 1ff6b671eb39a9d8fbccd527084aa5321d3f2e0a Mon Sep 17 00:00:00 2001 From: Gregory Ballantine Date: Fri, 5 Aug 2022 17:29:05 -0400 Subject: [PATCH] Updated the README; added copyright info to LICENSE file --- LICENSE | 2 +- README.md | 18 ++++++++++++++++-- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/LICENSE b/LICENSE index 5f662b3..200b455 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) +Copyright (c) 2022 Bit Goblin Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README.md b/README.md index 34bc313..c58055a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ -# test-scripts +# Bit Goblin Hardware Tests -Scripts used for testing hardware in Bit Goblin's videos \ No newline at end of file +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!