You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2016/02/01 22:32:08 UTC
[2/3] brooklyn git commit: add docs for using submodules
add docs for using submodules
Project: http://git-wip-us.apache.org/repos/asf/brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn/commit/ddabaed9
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn/tree/ddabaed9
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn/diff/ddabaed9
Branch: refs/heads/master
Commit: ddabaed9bdcf06ebfa15e025cd5df17b1e88fad1
Parents: acbb9f7
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Feb 1 21:07:19 2016 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Mon Feb 1 21:07:19 2016 +0000
----------------------------------------------------------------------
README.md | 36 +++++++++++++++++++++++++++++-------
1 file changed, 29 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn/blob/ddabaed9/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 519dbf8..1b1f315 100644
--- a/README.md
+++ b/README.md
@@ -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