Skip to content

Commit de9a6da

Browse files
committed
DOC: declare Python 3 compatibility in README.
Also state that scons is an optional dependency.
1 parent 9f6fffe commit de9a6da

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,16 @@ http://diffpy.github.io/pyobjcryst.
1616
REQUIREMENTS
1717
------------
1818

19-
pyobjcryst requires Python 2.7, C++ compiler and the following software:
19+
pyobjcryst requires Python 3.6, 3.5, 3.4 or 2.7, C++ compiler and
20+
the following software:
2021

2122
* ``libobjcryst`` - Object-Oriented Crystallographic Library for C++,
2223
https://github.com/diffpy/libobjcryst
2324
* ``setuptools`` - tools for installing Python packages
2425
* ``NumPy`` - library for scientific computing with Python
25-
* ``scons`` - software constructions tool (1.0 or later)
2626
* ``python-dev`` - header files for interfacing Python with C
2727
* ``libboost-all-dev`` - Boost C++ libraries and development files
28+
* ``scons`` - software constructions tool (optional)
2829

2930
We recommend to use `Anaconda Python <https://www.continuum.io/downloads>`_
3031
as it allows to install all software dependencies together with
@@ -62,13 +63,13 @@ You may need to use ``sudo`` with system Python so the process is
6263
allowed to copy files to system directories. If administrator (root)
6364
access is not available, see the usage information from
6465
``python setup.py install --help`` for options to install to
65-
a user-writable location. The installation integrity can be verified by
66-
changing to the HOME directory and running ::
66+
a user-writable location. The installation integrity can be
67+
verified by executing the included tests with ::
6768

6869
python -m pyobjcryst.tests.run
6970

7071
An alternative way of installing pyobjcryst is to use the SCons tool,
71-
which can speed up the installation by compiling C++ files in several
72+
which can speed up the process by compiling C++ files in several
7273
parallel jobs (-j4)::
7374

7475
scons -j4 install

0 commit comments

Comments
 (0)