Skip to content

Commit

Permalink
MAINT: Improve README (#11673)
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel McCloy <[email protected]>
  • Loading branch information
larsoner and drammock authored May 3, 2023
1 parent 16fe5b5 commit 24dff77
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
21 changes: 10 additions & 11 deletions README.rst
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
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

0 comments on commit 24dff77

Please sign in to comment.