Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

## Building on Linux

 

Set the DOCFORMATS_DIR environment variable to the location of the repository root. Then, anywhere on your filesystem:

 

    mkdir build

    cd build

    cmake -G "Unix Makefiles" $DOCFORMATS_DIR

    make

 

This will produce two binaries:

 

    DocFormats/libDocFormats.a -- a static library

    dfutil/dfutil -- the driver program

 

Note that, as per standard cmake practice, you should always build separately from the source tree (although a separate subdirectory within the source tree is acceptable).

 

To run the tests, do the following:

 

    dfutil -test $DOCFORMATS_DIR/tests

 

## Building on OS X

 

You can either use the instructions above for building using make, or alternatively generate an Xcode project:

 

    mkdir build

    cd build

    cmake -G Xcode $DOCFORMATS__DIR

 

This will produce DocFormats.xcodeproj, which you can then open in Xcode.

## Building on Windows

 

 Build