diff --git a/README.rst b/README.rst index 2370eb9..ec54a1a 100644 --- a/README.rst +++ b/README.rst @@ -25,14 +25,32 @@ To see the latest changes in ``radiospectra`` see our `changelog `__. -To install ``radiospectra`` once miniforge is installed run the following command: +Standard Installation +--------------------- +The recommended way to install ``radiospectra`` is via pip: -.. code:: bash +.. code-block:: bash - $ conda install radiospectra + pip install radiospectra + +Development Setup +----------------- +If you want to contribute to the development of ``radiospectra``, please follow these steps: + +1. **Prerequisites**: We recommend using ``miniforge`` or ``conda`` to manage dependencies. Please refer to the official `SunPy Conda Guide `_ for detailed environment setup. + +2. **Editable Install**: Clone the repository and install it in editable mode: + +.. code-block:: bash + + pip install -e ".[dev,docs]" + +3. **Verify Installation**: Run the tests to ensure everything is working correctly: + +.. code-block:: bash + + pytest -For detailed installation instructions, see the `installation guide `__ in the ``sunpy`` docs. Getting Help ============ diff --git a/changelog/170.doc.rst b/changelog/170.doc.rst new file mode 100644 index 0000000..19f5277 --- /dev/null +++ b/changelog/170.doc.rst @@ -0,0 +1 @@ +Added a "Development Setup" section to the README to assist new contributors.