diff --git a/README.rst b/README.rst index f1b0dd2..ce9e29e 100644 --- a/README.rst +++ b/README.rst @@ -89,6 +89,14 @@ 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. + +Now, you may consult our `online documentation `_ for tutorials and API references. + Support and Contribute ---------------------- diff --git a/news/update-install-check.rst b/news/update-install-check.rst new file mode 100644 index 0000000..5640ded --- /dev/null +++ b/news/update-install-check.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* Updated REAMDE instructions to check for successful installation + +**Security:** + +*