diff --git a/README b/README deleted file mode 100644 index bd66bed..0000000 --- a/README +++ /dev/null @@ -1,9 +0,0 @@ - -- Steps to run bootrr locally (helpful while testing on local board or - creating new tests) - - Clone the bootrr repo or use a tarball from repo - Run the below cmds for running tests for a given board locally - - # export PATH=$PWD/helpers:$PATH - # ./boards/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..63e1f4e --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ + +# Bootrr + +A sanity checker for boards under automated test on LAVA. + +Before running the tests for your software stack on LAVA, you really want to +ensure that the basics are in place. + +Testing that all the expected hardware is detected and that modules and +firmwares can be loaded catches some very common kind of regressions: for +instance, when renaming identifiers it is often the case that firmware blobs no +longer get loaded since their location needs to be updated accordingly. + +This repository contains: +* static board descriptions that list what to expect for each specific + board type +* helpers to inspect the current system and compare it against the static board + description for it +* the `bootrr` script to automatically detect the current board and run + the matching tests + +The output is in a format meant to be directly parsed by LAVA. + +## Install + +```sh +$ make prefix=/usr/local DESTDIR=/ install +``` + +## Usage + +```sh +$ bootrr + + +``` + +## Related Efforts + +- [LAVA](https://lavasoftware.org/) - A continuous integration system for deploying operating systems onto physical and virtual hardware for running tests. +- [KernelCI](https://kernelci.org/) - Community-led test system focused on the upstream Linux kernel. + +## License + +BSD-3-Clause