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.

Sign up for GitHub

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6243ba0
MAINT: Improve README [skip azp] [skip cirrus] [skip circle]
larsoner May 3, 2023
4146c12
Update README.rst [ci skip]
drammock May 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,22 @@ Documentation
`MNE documentation`_ for MNE-Python is available online.


Forum
^^^^^^

Our user forum is https://mne.discourse.group and is the best place to ask
questions about MNE-Python usage or about the contribution process. It also
includes job opportunities and other announcements.


Installing MNE-Python
^^^^^^^^^^^^^^^^^^^^^

To install the latest stable version of MNE-Python, you can use pip_ in a terminal:

.. code-block:: console

$ pip install -U mne
$ pip install --upgrade mne

- MNE-Python 0.17 was the last release to support Python 2.7
- MNE-Python 0.18 requires Python 3.5 or higher
Expand All @@ -65,17 +73,14 @@ To install the latest version of the code using pip_ open a terminal and type:

.. code-block:: console

$ pip install -U https://github.com/mne-tools/mne-python/archive/main.zip
$ pip install --upgrade git+https://github.com/mne-tools/mne-python@main

To get the latest code using `git <https://git-scm.com/>`__, open a terminal and type:

.. code-block:: console

$ git clone https://github.com/mne-tools/mne-python.git

Alternatively, you can also download a
`zip file of the latest development version <https://github.com/mne-tools/mne-python/archive/main.zip>`__.


Dependencies
^^^^^^^^^^^^
Expand Down Expand Up @@ -126,12 +131,6 @@ Please see the documentation on the MNE-Python homepage:
https://mne.tools/dev/install/contributing.html


Forum
^^^^^^

https://mne.discourse.group


Licensing
^^^^^^^^^

Expand Down
7 changes: 5 additions & 2 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,12 @@ def package_tree(pkgroot):
],
keywords="neuroscience neuroimaging MEG EEG ECoG fNIRS brain",
project_urls={
"Homepage": "https://mne.tools/",
"Download": "https://pypi.org/project/scikit-learn/#files",
"Bug Tracker": "https://github.com/mne-tools/mne-python/issues/",
"Documentation": "https://mne.tools/",
"Source": "https://github.com/mne-tools/mne-python/",
"Tracker": "https://github.com/mne-tools/mne-python/issues/",
"Forum": "https://mne.discourse.group/",
"Source Code": "https://github.com/mne-tools/mne-python/",
},
platforms="any",
python_requires=">=3.8",
Expand Down