Skip to content

Commit bbae242

Browse files
committed
Update getting started, installation in readme
1 parent 30f706c commit bbae242

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.rst

+11-4
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,16 @@ To add "conda-forge" to the conda channels, run the following in a terminal. ::
7878
We want to install our packages in a suitable conda environment.
7979
The following creates and activates a new environment named ``diffpy.pdfgui_env`` ::
8080

81-
conda create -n diffpy.pdfgui_env python=3
81+
conda create -n diffpy.pdfgui_env diffpy.pdfgui
8282
conda activate diffpy.pdfgui_env
8383

84-
Then, to fully install ``diffpy.pdfgui`` in our active environment, run ::
84+
To confirm that the installation was successful, type ::
8585

86-
conda install diffpy.pdfgui
86+
python -c "import diffpy.pdfgui; print(diffpy.pdfgui.__version__)"
8787

88-
Another option is to use ``pip`` to download and install the latest release from
88+
The output should print the latest version displayed on the badges above.
89+
90+
If the above does not work, you can use ``pip`` to download and install the latest release from
8991
`Python Package Index <https://pypi.python.org>`_.
9092
To install using ``pip`` into your ``diffpy.pdfgui_env`` environment, type ::
9193

@@ -97,6 +99,11 @@ and run the following ::
9799

98100
pip install .
99101

102+
Getting Started
103+
---------------
104+
105+
You may consult our user manual in our `online website <https://www.diffpy.org/products/pdfgui.html>`_ under the Documentation and help section.
106+
100107
Support and Contribute
101108
----------------------
102109

0 commit comments

Comments
 (0)