From f3beb40a0b86cc7511b3a149a5bd0d8cc1483126 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Mon, 21 Oct 2024 16:00:30 -0400 Subject: [PATCH 1/3] Add instructions for checking successfull install --- README.rst | 6 ++++++ news/update-install-check.rst | 23 +++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 news/update-install-check.rst diff --git a/README.rst b/README.rst index f1b0dd2..6245c3a 100644 --- a/README.rst +++ b/README.rst @@ -89,6 +89,12 @@ 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. + 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:** + +* From 839beb097b5e83af85a50210a0e965f026c3f8f4 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 21 Oct 2024 20:01:23 +0000 Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit hooks --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 6245c3a..32a4a3a 100644 --- a/README.rst +++ b/README.rst @@ -90,7 +90,7 @@ 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. From f2c3d451511192174fd6a4e7d8d16a530439387c Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Mon, 21 Oct 2024 16:03:23 -0400 Subject: [PATCH 3/3] Add one-liner for checking online doc --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index 6245c3a..138c419 100644 --- a/README.rst +++ b/README.rst @@ -95,6 +95,8 @@ To confirm that the installation was successful, type :: 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 ----------------------