Skip to content

Commit

Permalink
update the README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
Dou Du committed Jun 10, 2024
1 parent e65f344 commit 5726fbc
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,21 @@ This will
- update version numbers, make a corresponding `git commit` and a `git tag`;
- push this commit and tag to Github, which triggers the Github Action that makes a new Github Release and publishes the package to PYPI.


### 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` failed, it means there is sometime wrong with the code and the widget is NOT
showing 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` passed but the `screenshot comparsion` failed, it means the appearance of the widget
is different from previous version. One need manually download the artfact from `widget test` and use it
replace the figure `widget-sample.png` in the `test` folder.

## Acknowledgements

We acknowledge support from the EPFL Open Science Fund via the [OSSCAR](http://www.osscar.org) project.
Expand Down

0 comments on commit 5726fbc

Please sign in to comment.