Skip to content

Commit 02cf744

Browse files
committed
format fix in manual and README.md
1 parent eb2302b commit 02cf744

2 files changed

Lines changed: 6 additions & 10 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ If administrator (root) access is not available, see the usage info from
6868
`scons --help` for options to install to a user-writable location.
6969

7070

71-
## DEVELOPMENT
71+
## CONTRIBUTION
7272

7373
libdiffpy is an open-source software developed as a part of the
7474
DiffPy-CMI complex modeling initiative at the Brookhaven National

doc/manual/source/install.rst

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,13 @@ Recommended software:
1515
* `cxxtest` - CxxTest Unit Testing Framework, http://cxxtest.com/
1616

1717
Required software is usually available in the system package manager,
18-
for example, on Ubuntu Linux the dependencies can be installed as
18+
for example, on Ubuntu Linux the dependencies can be installed as::
1919

20-
sh
2120
sudo apt-get install \
22-
build-essential scons libboost-dev libgsl0-dev
21+
build-essential scons libboost-dev libgsl0-dev
2322

24-
For Mac OS X machine with the MacPorts package manager one could do
23+
For Mac OS X machine with the MacPorts package manager one could do::
2524

26-
sh
2725
sudo port install scons boost gsl
2826

2927

@@ -36,9 +34,8 @@ Installation
3634
------------------------------------------------------------------------
3735

3836

39-
To build and install the libdiffpy library from sources, run
37+
To build and install the libdiffpy library from sources, run::
4038

41-
sh
4239
sudo scons -j4 install
4340

4441
This installs libdiffpy for all users under the `/usr/local` directory.
@@ -59,9 +56,8 @@ https://github.com/diffpy/libdiffpy.
5956

6057
Feel free to fork the project and contribute. When developing it is
6158
preferable to compile with `build=develop` option, which compiles the
62-
library with debug information and C-assertions checks:
59+
library with debug information and C-assertions checks::
6360

64-
sh
6561
scons -j4 build=develop
6662

6763
The build script checks for a presence of `sconsvars.py` file, which

0 commit comments

Comments
 (0)