diff --git a/README.rst b/README.rst index ce9e29e..fa8667d 100644 --- a/README.rst +++ b/README.rst @@ -59,7 +59,6 @@ by citing the following paper in your publication: `__, *npj Comput Mater* **10**, 193 (2024). - Installation ------------ @@ -77,6 +76,12 @@ The following creates and activates a new environment named ``diffpy.snmf_env`` conda create -n diffpy.snmf_env diffpy.snmf conda activate diffpy.snmf_env +To confirm that the installation was successful, type :: + + python -c "import diffpy.snmf; print(diffpy.snmf.__version__)" + +The output should print the latest version displayed on the badges above. + If the above does not work, you can use ``pip`` to download and install the latest release from `Python Package Index `_. To install using ``pip`` into your ``diffpy.snmf_env`` environment, type :: @@ -89,13 +94,10 @@ and run the following :: pip install . -To confirm that the installation was successful, type :: - - python -c "import diffpy.snmf; print(diffpy.snmf.__version__)" - -The output should print the latest version displayed on the badges above. +Getting Started +--------------- -Now, you may consult our `online documentation `_ for tutorials and API references. +You may consult our `online documentation `_ for tutorials and API references. Support and Contribute ---------------------- diff --git a/news/update-install.rst b/news/update-install.rst new file mode 100644 index 0000000..95b6c1b --- /dev/null +++ b/news/update-install.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* Add getting started section and re-arrange install success check instructions + +**Security:** + +*