Skip to content

Commit 9e221ab

Browse files
committed
update the doc to 1.2a0
1 parent f99b6cb commit 9e221ab

File tree

2 files changed

+23
-252
lines changed

2 files changed

+23
-252
lines changed

doc/manual/make.bat

Lines changed: 0 additions & 242 deletions
This file was deleted.

doc/manual/source/install.rst

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,21 @@ libdiffpy library requires C++ compiler and the following software:
1111

1212
Recommended software:
1313

14-
* `libObjCryst` - C++ library of free objects for crystallography, FIXME-URL
15-
* `cxxtest` - CxxTest Unit Testing Framework, http://cxxtest.com/
14+
* `libobjcryst` - C++ library of free objects for crystallography,
15+
https://github.com/diffpy/libobjcryst
16+
* `cxxtest` - CxxTest Unit Testing Framework, http://cxxtest.com
1617

17-
Required software is usually available in the system package manager,
18-
for example, on Ubuntu Linux the dependencies can be installed as::
18+
On Ubuntu Linux the required software can be installed using the
19+
system package manager::
1920

2021
sudo apt-get install \
2122
build-essential scons libboost-dev libgsl0-dev
2223

23-
For Mac OS X machine with the MacPorts package manager one could do::
24+
For Mac OS X machine with the MacPorts package manager the installation
25+
command is::
2426

2527
sudo port install scons boost gsl
2628

27-
2829
For other packages see their project pages for installation instructions.
2930

3031

@@ -42,12 +43,23 @@ This installs libdiffpy for all users under the `/usr/local` directory.
4243
If administrator (root) access is not available, see the usage info from
4344
`scons --help` for options to install to a user-writable location.
4445

46+
To verify libdiffpy installation, compile and run the included
47+
test code [examples/testlib.cpp](examples/testlib.cpp)::
4548

46-
.. index:: Contribution
49+
cd examples
50+
c++ testlib.cpp -ldiffpy
51+
./a.out
52+
53+
If compilation fails because of missing header files or missing libdiffpy
54+
library, adjust the `CPATH` and `LIBRARY_PATH` environment variables or
55+
use the `-I` or `-L` compiler options. If the libdiffpy shared library
56+
cannot be found at runtime, adjust the `LD_LIBRARY_PATH` environment variable.
4757

48-
Contribution
49-
------------------------------------------------------------------------
5058

59+
.. index:: Development
60+
61+
Development
62+
------------------------------------------------------------------------
5163

5264
libdiffpy is an open-source software developed as a part of the
5365
DiffPy-CMI complex modeling initiative at the Brookhaven National
@@ -64,4 +76,5 @@ The build script checks for a presence of `sconsvars.py` file, which
6476
can be used to permanently set the `build` variable. The SCons
6577
construction environment can be further customized in a `sconscript.local`
6678
script. The library integrity can be verified by executing unit tests with
67-
`scons -j4 test` (requires the CxxTest framework).
79+
`scons -j4 test` (requires the CxxTest framework).
80+

0 commit comments

Comments
 (0)