Skip to content

Commit 3aec5a3

Browse files
Alison WuAlison Wu
authored andcommitted
Update README
1 parent 6528940 commit 3aec5a3

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,16 +80,18 @@ To add "conda-forge" to the conda channels, run the following in a terminal. ::
8080
We want to install our packages in a suitable conda environment.
8181
The following creates and activates a new environment named ``diffpy.utils_env`` ::
8282

83-
conda create -n diffpy.utils_env python=3
83+
conda create -n diffpy.utils_env diffpy.utils
8484
conda activate diffpy.utils_env
8585

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

88-
conda install diffpy.utils
88+
python -c "import diffpy.utils; print(diffpy.utils.__version__)"
8989

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

9496
pip install diffpy.utils
9597

@@ -99,12 +101,17 @@ and run the following ::
99101

100102
pip install .
101103

104+
Getting Started
105+
---------------
106+
107+
You may consult our `online documentation <https://diffpy.github.io/diffpy.utils>`_ for tutorials and API references.
108+
102109
Support and Contribute
103110
----------------------
104111

105112
`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.utils. Please join the diffpy.utils users community by joining the Google group. The diffpy.utils project welcomes your expertise and enthusiasm!
106113

107-
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.utils/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.utils/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
114+
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.utils/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.utils/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
108115

109116
Feel free to fork the project and contribute. To install diffpy.utils
110117
in a development mode, with its sources being directly used by Python

0 commit comments

Comments
 (0)