Skip to content
Permalink
Browse files
add docs for using submodules
  • Loading branch information
ahgittin committed Feb 1, 2016
1 parent acbb9f7 commit ddabaed9bdcf06ebfa15e025cd5df17b1e88fad1
Showing 1 changed file with 29 additions and 7 deletions.
@@ -6,17 +6,39 @@
It supports blueprints in YAML or Java, and deploys them to many clouds and other target environments.
It monitors those deployments, maintains a live model, and runs autonomic policies to maintain their health.

For more information see **[brooklyn.apache.org](https://brooklyn.apache.org/)**.
For more information visit **[ brooklyn.apache.org ]( https://brooklyn.apache.org/ )**,
where you'll find:
* **[ Pre-built binaries ]( https://brooklyn.apache.org/download/ )**
* **[ Getting Started instructions ]( https://brooklyn.apache.org/v/latest/start/running.html )**
* **[ A Product Tour ](https://brooklyn.apache.org/learnmore/index.html)**


### To Build
### Quick Start

This is the uber-repo. To build the product, ensure that the other `brooklyn-*` projects are checked out,
currently as *siblings* to this directory (but with a notion to make them submodules), and then:
This is the uber-repo. To build the entire codebase,
get this project and its sub-modules:

git clone http://github.com/apache/brooklyn/
cd brooklyn
git submodule init
git submodule update --remote --merge --recursive

And then:

mvn clean install

This creates a build in `brooklyn-dist/usage/dist/target/brooklyn-dist`. Run with `bin/brooklyn launch`.
The results are in `brooklyn-dist/usage/dist/target/`.
To run, you might:

pushd brooklyn-dist/usage/dist/target/brooklyn-dist/brooklyn/
bin/brooklyn launch


### Resources

The **[developer guide](https://brooklyn.apache.org/v/latest/dev/)**
has more information about the source code.
The developer guide [for this version 0.9.0-SNAPSHOT](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/) <!-- BROOKLYN_VERSION --> contains more detail on:
* working with **[source code](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/code)** <!-- BROOKLYN_VERSION -->
* using **[git sub-modules](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/code/submodules.md)** effectively <!-- BROOKLYN_VERSION -->
* **[avoiding](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/code/no-submodules.md)** sub-modules <!-- BROOKLYN_VERSION -->
* **[project structure](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/code/structure.md)** <!-- BROOKLYN_VERSION -->
* the **[people](https://brooklyn.apache.org/community/index.html)** behind Apache Brooklyn

0 comments on commit ddabaed

Please sign in to comment.