diff --git a/tools/regression-tests/README.md b/tools/regression-tests/README.md new file mode 100644 index 0000000000..4eef685940 --- /dev/null +++ b/tools/regression-tests/README.md @@ -0,0 +1,10 @@ +This is a work in progress for enabling regression tests using in-place example scripts. + +Usage: (to be changed) +``` + python3 --lmp-bin=../../build/lmp --config-file=config.yaml +``` + +will iterative through the input scripts `in.*` in the working folder +using the given LAMMPS binary and the configuration defined in `config.yaml`. +