48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
|
# Building
|
||
|
|
|
||
|
|
We use Apache Maven to build the code, docs, distribution, etc. and to manage dependencies.
|
||
|
|
|
||
|
|
The minimum required Maven version is 3.0.0.
|
||
|
|
|
||
|
|
Note that there are some [compatibility issues with Maven 3.X](https://cwiki.apache.org/confluence/display/MAVEN/Maven+3.x+Compatibility+Notes)
|
||
|
|
still unsolved. This is specially true for the ['site' plugin](https://maven.apache.org/plugins-archives/maven-site-plugin-3.3/maven-3.html).
|
||
|
|
|
||
|
|
## Full Release
|
||
|
|
|
||
|
|
The full release uses `gitbook` to build a static website from the documentation, if you don't have `gitbook` installed
|
||
|
|
then you can build the distribution without docs (see below) or install `gitbook` using `npm`:
|
||
|
|
|
||
|
|
$ npm install -g gitbook gitbook-cli
|
||
|
|
|
||
|
|
If you don't have `npm` installed then you would need to install it first.
|
||
|
|
|
||
|
|
#### Install npm On Fedora
|
||
|
|
|
||
|
|
$ yum install npm
|
||
|
|
|
||
|
|
#### Install npm On Mac-OS
|
||
|
|
|
||
|
|
The easiest way would be through brew [brew]
|
||
|
|
|
||
|
|
You first install brew using the instructions on the [brew] website.
|
||
|
|
|
||
|
|
After you installed brew you can install npm by:
|
||
|
|
|
||
|
|
brew install npm
|
||
|
|
|
||
|
|
[brew]: <http://brew.sh>
|
||
|
|
|
||
|
|
To build the full release with documentation, Javadocs, and the full web site:
|
||
|
|
|
||
|
|
$ mvn -Prelease package
|
||
|
|
|
||
|
|
To install it to your local maven repo:
|
||
|
|
|
||
|
|
$ mvn -Prelease install
|
||
|
|
|
||
|
|
## Build the distribution without docs
|
||
|
|
|
||
|
|
It is possible to build a distribution with out the manuals and Javadocs if you don't have or want `gitbook` installed,
|
||
|
|
simply run
|
||
|
|
|
||
|
|
$ mvn package
|