Skip to content
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

MAINT: Improve README #11673

Merged
merged 2 commits into from
May 3, 2023
Merged

MAINT: Improve README #11673

merged 2 commits into from
May 3, 2023

Conversation

larsoner
Copy link
Member

@larsoner larsoner commented May 3, 2023

  1. Use --upgrade rather than -U as I think it's more standard (and clearer about its purpose, not confused with --user)
  2. Move the Forum subheading up so it's more discoverable
  3. Fix the pip dev install line
  4. Remove defunct suggestion to use the main.zip archive (git history is needed nowadays to get a usable version number)
  5. Improve our project_urls. I looked at matplotlib, numpy, scipy, pandas, and scikit-learn and tried to distill the common practices. Basically now we follow matplotlib but don't have their donate button. (I made a Homepage button that's redundant with Documentation since it seemed weird to have it missing -- if people are looking for either, they can land in the same place and I think it's okay.)

Only ran on GHA to save some CI cycles, so it'll need to be merged overriding branch protections. @drammock feel free to take a look!

@larsoner larsoner added this to the 1.4 milestone May 3, 2023
README.rst Outdated Show resolved Hide resolved
@drammock drammock merged commit 24dff77 into mne-tools:main May 3, 2023
@drammock
Copy link
Member

drammock commented May 3, 2023

thx @larsoner

@larsoner larsoner deleted the readme branch May 3, 2023 18:13
larsoner added a commit to larsoner/mne-python that referenced this pull request May 4, 2023
* upstream/main:
  ENH: Change known_config_types to dict (mne-tools#11166)
  MAINT: Improve README (mne-tools#11673)
larsoner added a commit to larsoner/mne-python that referenced this pull request May 18, 2023
* upstream/main: (32 commits)
  MAINT: Update download buttons [skip azp] [skip actions] [skip cirrus]
  Fix canvas.draw() in callback (mne-tools#11697)
  Remove recursion in plot_ica_components and use context manager for plt.ion/plt.ioff (mne-tools#11696)
  Update affiliation (mne-tools#11695)
  BUG: Fix bug with fwd restriction (mne-tools#11694)
  MRG: Suggest using "conda rename" in MNE updating instructions (mne-tools#11692)
  FIX: Regex [ci skip]
  MAINT: Apply deprecations [circle deploy] (mne-tools#11687)
  MAINT: Release 1.4.0 (mne-tools#11686)
  Trap music (mne-tools#11679)
  Fix call to plot_tfr_topomap from interactive AverageTFR.plot_topo function (mne-tools#11683)
  silence spectrum plot warning in examples/tutorials [circle full] (mne-tools#11682)
  Spectrum plot picks (mne-tools#11680)
  Update website conf (mne-tools#11675)
  BUG: Fix bug with MF LCMV rank (mne-tools#11664)
  ENH: Change known_config_types to dict (mne-tools#11166)
  MAINT: Improve README (mne-tools#11673)
  MAINT: Add to git-blame-ignore-revs [circle front]
  MAINT: Run black on codebase
  MAINT: Use black
  ...
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.

2 participants