- Introduction
- 1. Legal Notice
- 2. Working with the Code
- 3. IDE Integration
- 4. Building
- 5. Tests
- 6. Code Formatting
- 7. Validating releases
- 8. Notes for Maintainers
- Published using GitBook

# ActiveMQ Artemis Documentation

# 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 still unsolved. This is specially true for the 'site' plugin.

## 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

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