-
Notifications
You must be signed in to change notification settings - Fork 33
Update getting started guide & add screenshot #43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
thx @hoechenberger looks great ! |
…wser into getting-started
|
Thank you @hoechenberger, great improvement of README.md. |
|
The CIs of |
|
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 |
1.0 release is very soon, I would just add an ignore line to https://github.com/mne-tools/mne-python/blob/main/mne/conftest.py#L130-L136 |
|
I think this one is save to merged without #48 for passing the CIs (changes here are not relevant for tests). |
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
sampledataset 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