diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000000000000000000000000000000000000..437a80502a338ade61b61e6c6d028a2687cfc348 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,14 @@ +# Tests + +Some test scripts to automate way of making sure that (almost) everything works as expected. + +## Inventory Test + +A shell script `inventory.sh` that loads the Fab inventory and checks that all electronics parts in the inventory are covered by the library. + +Usage: +``` +./inventory.sh ../fab.kicad_sym ./whitelist.txt +``` + +The `whitelist.txt` file is there for the script to skip certain parts that are not electronic components, such as [Amphenol ICC (FCI) 71600-104LF](https://www.digikey.fi/en/products/detail/amphenol-cs-fci/71600-104LF/1523943) ribbon cable connector, for example. \ No newline at end of file