From cf37b3c28154fc537fb16169a18ad53ceaf71b9b Mon Sep 17 00:00:00 2001 From: Kristjan Eimre Date: Fri, 12 Jul 2024 00:26:36 +0300 Subject: [PATCH] update README --- README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b3a65ab..af9680c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ [![PyPI version](https://badge.fury.io/py/widget-periodictable.svg)](https://badge.fury.io/py/widget-periodictable) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/osscar-org/widget-periodictable/main?urlpath=%2Fvoila%2Frender%2Fexamples%2Fintroduction.ipynb) -[![widget test](https://github.com/osscar-org/widget-periodictable/actions/workflows/widget-test.yml/badge.svg)](https://github.com/osscar-org/widget-periodictable/actions/workflows/widget-test.yml) [![screenshot comparison](https://github.com/osscar-org/widget-periodictable/actions/workflows/screenshot-comparison.yml/badge.svg)](https://github.com/osscar-org/widget-periodictable/actions/workflows/screenshot-comparison.yml) ![demo](https://raw.githubusercontent.com/osscar-org/widget-periodictable/main/example/demo.gif) @@ -48,16 +47,11 @@ This will ### Github workflow testing -[![widget test](https://github.com/osscar-org/widget-periodictable/actions/workflows/widget-test.yml/badge.svg)](https://github.com/osscar-org/widget-periodictable/actions/workflows/widget-test.yml) - -If the `widget test` fails, it indicates there is something wrong with the code, and the widget is NOT -being displayed correctly in the test. - [![screenshot comparison](https://github.com/osscar-org/widget-periodictable/actions/workflows/screenshot-comparison.yml/badge.svg)](https://github.com/osscar-org/widget-periodictable/actions/workflows/screenshot-comparison.yml) -If the `widget test` passes but the `screenshot comparison` fails, it indicates the appearance of the widget -is different from the previous version. In this case, you'll need to manually download the artifact from -the `widget test` and use it to replace the `widget-sample.png` figure in the `test` folder. +The `screenshot comparison` test will generate images of the widget using `selenium` and `chrome-driver`, and compares them to the reference image in `test/widget-sample.png`. + +To update the reference image: download the generated image from the Github Workflow step called "Upload screenshots". ## Acknowledgements