Skip to content

Commit afd8367

Browse files
authored
Merge pull request #115 from Sparks29032/patch-1
Update REAME.rst instructions
2 parents 8c69f4f + e95e785 commit afd8367

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.rst

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,13 @@ 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
58-
recommend using the Python 3 version. It makes use of several third party
57+
PDFmorph can be run with Python 3.10 or higher. It makes use of several third party
5958
libraries that you'll need to run the app and its components.
6059

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

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

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``
159+
1. Install pre-commit in your working environment by running ``conda install pre-commit``
161160

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``
161+
2. Initialize pre-commit (one time only) ``pre-commit install``
165162

166163
Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
167164
If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
168165
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
166+
trying to commit again.
170167

171168

172169
CONTACTS

0 commit comments

Comments
 (0)