Skip to content

Commit

Permalink
Add additional instructions for checking install success (#111)
Browse files Browse the repository at this point in the history
* Add instructions for checking successfull install

* [pre-commit.ci] auto fixes from pre-commit hooks

* Add one-liner for checking online doc

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
bobleesj and pre-commit-ci[bot] authored Oct 21, 2024
1 parent 9dbd1c3 commit 6ecd53a
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://diffpy.github.io/diffpy.snmf>`_ for tutorials and API references.

Support and Contribute
----------------------

Expand Down
23 changes: 23 additions & 0 deletions news/update-install-check.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* <news item>

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* Updated REAMDE instructions to check for successful installation

**Security:**

* <news item>

0 comments on commit 6ecd53a

Please sign in to comment.