Skip to content

Latest commit

 

History

History
27 lines (15 loc) · 1.36 KB

INSTALL.md

File metadata and controls

27 lines (15 loc) · 1.36 KB

How to build

Shapeshifter uses Maven as a build system. More information on how to get and use Maven may be found at maven.apache.org/.

Protocol Buffers

Apart from the standard dependencies declared in the pom.xml file, this library requires the Protocol Buffer compiler, a.k.a protoc, to be present on the host. protoc is an executable program distributed as part of the open-source Protocol Buffers project. You may install the compiler by downloading its source from the official repository and following the instructions for building it.

Maven Protoc Plugin

Shapeshifter's Maven artifact relies on Sergei Ivanov's Maven plugin for invoking the protocol buffer compiler. This plugin uses Maven's toolchain mechanism to find the path to the compiler. See the plugin's manual to find a sample configuration.

Building and packaging the library

Once you have installed protoc and declared the proper toolchain, you may build this library by running:

$ mvn compile

You may package this library by invoking:

$ mvn package