Skip to content

Commit d7b6618

Browse files
authored
Update README.rst
1 parent 8c69f4f commit d7b6618

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ and typing into a terminal window or Windows command prompt. It is
5454
recommended that you consult online resources and become somewhat
5555
familiar before using PDFmorph.
5656

57-
PDFmorph can be run with Python 2.7 and Python 3.5 or higher. We
57+
PDFmorph can be run with Python 2.7 and Python 3.10 or higher. We
5858
recommend using the Python 3 version. It makes use of several third party
5959
libraries that you'll need to run the app and its components.
6060

61-
* NumPy - library for scientific computing with Python
62-
* matplotlib - Python 2D plotting library
63-
* SciPy - library for highly technical Python computing
64-
* diffpy.utils - `shared helper utilities <https://github.com/diffpy/diffpy.utils/>`_ for wx GUI
61+
* `NumPy` - library for scientific computing with Python
62+
* `matplotlib` - Python 2D plotting library
63+
* `SciPy` - library for highly technical Python computing
64+
* `diffpy.utils` - `shared helper utilities <https://github.com/diffpy/diffpy.utils/>`_ for wx GUI
6565

6666
These dependencies will be installed automatically if you use the conda
6767
installation procedure described below.
@@ -157,16 +157,14 @@ We welcome contributors from the community. Please consider posting issues, and
157157
To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
158158
hooks.
159159

160-
1. modify the permissions to executable on the bash script called ``prevent_commit_to_main.sh`` in this directory: ``chmod +x prevent_commit_to_main.sh``
160+
1. Install pre-commit in your working environment with ``conda install pre-commit``
161161

162-
2. install pre-commit in your working environment with ``conda install pre-commit``
163-
164-
3. initialize pre-commit (one time only) ``pre-commit install``
162+
2. Initialize pre-commit (one time only) ``pre-commit install``
165163

166164
Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
167165
If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
168166
pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
169-
trying to commit again
167+
trying to commit again.
170168

171169

172170
CONTACTS

0 commit comments

Comments
 (0)