Skip to content

Conversation

@hoechenberger
Copy link
Member

@hoechenberger hoechenberger commented Feb 10, 2022

I tried to make it easier to get started by providing a single script (not split across several chunks) that users can just copy & paste. Using the sample dataset now so it it will work everywhere out of the box.

Also added a screenshot based on the branch with the new icons.

Careful: The embedded screenshot will break the rendering on PyPI because it's embedded into the readme via a relative link. Once this PR has been merged, we need to update the readme to include an absolute URL.

View the "rendered" readme here:
https://github.com/mne-tools/mne-qt-browser/blob/a729323786050575df84bdd9471d4e2857d328ce/README.md

WDYT?

cc @agramfort

@hoechenberger hoechenberger marked this pull request as ready for review February 10, 2022 08:33
@agramfort
Copy link
Member

thx @hoechenberger looks great !

@marsipu
Copy link
Member

marsipu commented Feb 10, 2022

Thank you @hoechenberger, great improvement of README.md.

@marsipu
Copy link
Member

marsipu commented Feb 10, 2022

The CIs of maint/0.24 are failing because the new pytest deprecates something which is only fixed from mne=1.0dev on, am I right?
Should we set a lower pytest-version for this case?
@larsoner @agramfort @hoechenberger What would be the general policy on testing past mne-releases? Every release since qt-backend was added or only stable+dev?

@larsoner
Copy link
Member

In MNE-Python we only support the current release (+dev), I would do the same for mne-qt-browser. So that means support 0.24+dev until 1.0 is released, then start supporting 1.0+dev here

@larsoner
Copy link
Member

are failing because the new pytest deprecates something which is only fixed

1.0 release is very soon, I would just add an ignore line to conftest.py like we do in MNE:

https://github.com/mne-tools/mne-python/blob/main/mne/conftest.py#L130-L136

@marsipu
Copy link
Member

marsipu commented Feb 10, 2022

@larsoner Thanks, put in #48

@marsipu marsipu merged commit e7c2593 into mne-tools:main Feb 11, 2022
@marsipu
Copy link
Member

marsipu commented Feb 11, 2022

I think this one is save to merged without #48 for passing the CIs (changes here are not relevant for tests).
Thank you @hoechenberger

@hoechenberger hoechenberger deleted the getting-started branch February 11, 2022 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants