diff --git a/docs/source/gettingstarted.rst b/docs/source/gettingstarted.rst index a21bf207..68633101 100644 --- a/docs/source/gettingstarted.rst +++ b/docs/source/gettingstarted.rst @@ -9,17 +9,23 @@ Installation $ pip install roiextractors -#. You can check for any missing packages by explicitly installing from the `requirements `_ file: - .. code-block:: shell - - $ pip install -r requirements.txt #. **Cloning the github repo**: .. code-block:: shell $ git clone https://github.com/SpikeInterface/spikeinterface.git $ cd spikeinterface - $ python setup.py install (or develop) + $ pip install --editable . + +You can also install the optional dependencies by installing the package with the following command: + +.. code-block:: shell + + $ pip install "roiextractors[full]" + $ pip install "roiextractors[test]" + $ pip install "roiextractors[docs]" + +These commands install the full, test, and documentation dependencies, respectively. What is RoiExtractors --------------------- diff --git a/pyproject.toml b/pyproject.toml index ce267ec5..50964dd4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,7 +29,12 @@ classifiers = [ "Operating System :: MacOS", "License :: OSI Approved :: BSD License", ] -urls = { Homepage = "https://github.com/catalystneuro/roiextractors" } +urls = { Homepage = } + +[project.urls] +"Homepage" = "https://github.com/catalystneuro/roiextractors" +"Documentation" = "https://roiextractors.readthedocs.io//" +"Changelog" = "https://github.com/catalystneuro/roiextractors/blob/main/CHANGELOG.md" requires-python = ">=3.9"