Skip to content

Commit 6ecd53a

Browse files
Add additional instructions for checking install success (#111)
* 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>
1 parent 9dbd1c3 commit 6ecd53a

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

README.rst

+8
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,14 @@ and run the following ::
8989

9090
pip install .
9191

92+
To confirm that the installation was successful, type ::
93+
94+
python -c "import diffpy.snmf; print(diffpy.snmf.__version__)"
95+
96+
The output should print the latest version displayed on the badges above.
97+
98+
Now, you may consult our `online documentation <https://diffpy.github.io/diffpy.snmf>`_ for tutorials and API references.
99+
92100
Support and Contribute
93101
----------------------
94102

news/update-install-check.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* <news item>
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* Updated REAMDE instructions to check for successful installation
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)