Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 1.73 KB

INSTALL.rst

File metadata and controls

61 lines (41 loc) · 1.73 KB

Obtaining

mglib is available from GitHub, either through git or as downloading a zip file. The mgcmake submodule must also be retrieved as well, run the init.sh script in the mglib root directory to get it.

Building

Use CMake to configure mglib before building. For example, for a basic install, you could do the following from the root directory of mglib:

cmake -DCMAKE_INSTALL_PREFIX=/path/to/install .

There are more complete example configuration commands in homebrew_configure.sh (for OS X builds using homebrew to get dependencies), unix_configure.sh (for basic unix configuration), and simmple_configure.sh (which doesn't build any DLMs with dependencies) which specifies some optional libraries that cause DLMs that depend on them to be built. These example configuration scripts build out-of-source, so change to the build directory before building:

cd build

Then build mglib with:

make

And install with:

make install

Testing

Running the unit tests requires mgunit, a unit testing framework for IDL. Download mgunit and place it in your IDL path. To run the mglib unit tests, use the unit Makefile target:

make unit

Generating documentation

Generating the API documentation for mglib requires IDLdoc. Download IDLdoc and place it in your IDL path. To generate the API documentation, use the doc or userdoc Makefile targets:

make doc
make userdoc

The doc target generates documentation appropriate for developers or contributors to mglib, while userdoc generates documentation appropriate for users of mglib.