Updated the README; added copyright info to LICENSE file
This commit is contained in:
parent
33e540add4
commit
1ff6b671eb
2
LICENSE
2
LICENSE
@ -1,4 +1,4 @@
|
|||||||
Copyright (c) <year> <owner>
|
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:
|
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
18
README.md
18
README.md
@ -1,3 +1,17 @@
|
|||||||
# test-scripts
|
# Bit Goblin Hardware Tests
|
||||||
|
|
||||||
Scripts used for testing hardware in Bit Goblin's videos
|
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!
|
||||||
|
Loading…
Reference in New Issue
Block a user