From 147d6611a64a6ab04611b923e30efacaca6fc678 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Thu, 2 Mar 2023 19:43:44 +0100 Subject: [PATCH] readme: update test suite instructions Since eed3e1e0f82b ("test: remove edid-decode as a test dependency"), edid-decode is no longer required to run the test suite. It's only required to re-generate the test data. Expand a bit on how to setup edid-decode to re-generate the test data. Signed-off-by: Simon Ser --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c155196..f9eff06 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,9 @@ The low-level EDID library is tested against [edid-decode]. `test/data/` contains a small collection of EDID blobs and diffs between upstream `edid-decode` and our `di-edid-decode` clone. Our CI ensures the diffs are up-to-date. A patch should never make the diffs grow larger. To re-generate the -test data, run `ninja -C build/ gen-test-data`. - -To run the test suite locally, you need to use [edid-decode] of the git -revision mentioned in `.gitlab-ci.yml`. Otherwise you may experience false -failures. +test data, build `edid-decode` at the Git revision mentioned in +`.gitlab-ci.yml`, put the executable in `PATH`, and run +`ninja -C build/ gen-test-data`. The latest code coverage report is available on [GitLab CI][coverage].