Skip to content

Commit 713d218

Browse files
committed
Fix inline verbatim quotations in rst format.
1 parent cad40aa commit 713d218

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

README.rst

+25-25
Original file line numberDiff line numberDiff line change
@@ -13,59 +13,59 @@ REQUIREMENTS
1313
pyobjcryst requires Python 2.6 or 2.7, C++ compiler and the following
1414
software:
1515

16-
* **libobjcryst** - Object-Oriented Crystallographic Library for C++,
17-
https://github.com/diffpy/libobjcryst/
18-
* **setuptools** - tools for installing Python packages
19-
* **python-dev** - header files for interfacing Python with C
20-
* **libboost-dev** - Boost C++ libraries development files
16+
* ``libobjcryst`` - Object-Oriented Crystallographic Library for C++,
17+
https://github.com/diffpy/libobjcryst
18+
* ``setuptools`` - tools for installing Python packages
19+
* ``python-dev`` - header files for interfacing Python with C
20+
* ``libboost-dev`` - Boost C++ libraries development files
2121

2222
With the exception of libobjcryst, the required software is commonly
2323
available in system package manager, for example, on Ubuntu Linux the
2424
required software can be installed as::
2525

26-
sudo apt-get install \
27-
python-setuptools python-dev libboost-dev build-essential
26+
sudo apt-get install \
27+
python-setuptools python-dev libboost-dev build-essential
2828

2929
For Mac OS X machine with the MacPorts package manager the installation is::
3030

31-
sudo port install \
32-
python27 py27-setuptools scons boost
31+
sudo port install \
32+
python27 py27-setuptools scons boost
3333

3434
When installing with MacPorts, make sure that MacPorts bin directory is the
3535
first in the system PATH and python27 is selected as the default Python
3636
version in MacPorts::
3737

38-
sudo port select --set python python27
38+
sudo port select --set python python27
3939

4040

4141
INSTALLATION
4242
------------
4343

4444
The easiest option is to use the latest DiffPy-CMI release bundle from
45-
http://www.diffpy.org/, which comes with pyobjcryst and all other
45+
http://www.diffpy.org, which comes with pyobjcryst and all other
4646
dependencies included.
4747

4848
If you prefer to install from sources, you must first install the libobjcryst
4949
library as per the instructions at
50-
https://github.com/diffpy/libobjcryst/. Make sure other required
50+
https://github.com/diffpy/libobjcryst. Make sure other required
5151
software is in place as well and then run::
5252

53-
sudo python setup.py install
53+
sudo python setup.py install
5454

5555
This installs pyobjcryst for all users to the default system location.
5656
If administrator (root) access is not available, see the usage info from
57-
`python setup.py install --help` for options for installing to a user-writable
57+
``python setup.py install --help`` for options for installing to a user-writable
5858
location. The installation integrity can be verified by changing to
5959
the HOME directory and running::
6060

61-
python -m pyobjcryst.tests.run
61+
python -m pyobjcryst.tests.run
6262

6363
An alternative way of installing pyobjcryst is to use the SCons tool,
6464
which can speed up the process by compiling C++ files in parallel (-j4)::
6565

66-
sudo scons -j4 install
66+
sudo scons -j4 install
6767

68-
See `scons -h` for description of build targets and options for
68+
See ``scons -h`` for description of build targets and options for
6969
choosing the installation directory.
7070

7171

@@ -81,26 +81,26 @@ Feel free to fork the project and contribute. To install pyobjcryst
8181
in a development mode, where its sources are directly used by Python
8282
rather than copied to a system directory, use::
8383

84-
python setup.py develop --user
84+
python setup.py develop --user
8585

8686
When developing it is preferable to compile the C++ files with
87-
SCons using the `build=develop` option, which compiles the extension
87+
SCons using the ``build=develop`` option, which compiles the extension
8888
module with debug information and C-assertions checks::
8989

90-
scons -j4 build=debug develop
90+
scons -j4 build=debug develop
9191

92-
The build script checks for a presence of `sconsvars.py` file, which
93-
can be used to permanently set the `build` variable. The SCons
94-
construction environment can be further customized in a `sconscript.local`
92+
The build script checks for a presence of ``sconsvars.py`` file, which
93+
can be used to permanently set the ``build`` variable. The SCons
94+
construction environment can be further customized in a ``sconscript.local``
9595
script. The package integrity can be verified by executing unit tests with
96-
`scons -j4 test`.
96+
``scons -j4 test``.
9797

9898

9999
CONTACTS
100100
--------
101101

102102
For more information on pyobjcryst please visit the project web-page
103103

104-
http://www.diffpy.org/
104+
http://www.diffpy.org
105105

106106
or email Prof. Simon Billinge at [email protected].

0 commit comments

Comments
 (0)