Update instructions in reamde for conda/pip install (#110)

* Update conda forge and pip install instruction * Add news
diffpy · Oct 21, 2024 · 9dbd1c3 · 9dbd1c3
1 parent 9840e0d
commit 9dbd1c3
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 6 deletions.
diff --git a/README.rst b/README.rst
@@ -74,14 +74,10 @@ To add "conda-forge" to the conda channels, run the following in a terminal. ::
 We want to install our packages in a suitable conda environment.
 The following creates and activates a new environment named ``diffpy.snmf_env`` ::
 
-        conda create -n diffpy.snmf_env python=3
+        conda create -n diffpy.snmf_env diffpy.snmf
         conda activate diffpy.snmf_env
 
-Then, to fully install ``diffpy.snmf`` in our active environment, run ::
-
-        conda install diffpy.snmf
-
-Another option is to use ``pip`` to download and install the latest release from
+If the above does not work, you can use ``pip`` to download and install the latest release from
 `Python Package Index <https://pypi.python.org>`_.
 To install using ``pip`` into your ``diffpy.snmf_env`` environment, type ::
 

diff --git a/news/update-install.rst b/news/update-install.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* Updated REAMDE instructions for pip and conda-forge install
+
+**Security:**
+
+* <news item>