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/02 01:39:00 UTC
[2/2] brooklyn git commit: change README to point at this version
docs for code
change README to point at this version docs for code
Project: http://git-wip-us.apache.org/repos/asf/brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn/commit/fa95695e
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn/tree/fa95695e
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn/diff/fa95695e
Branch: refs/heads/master
Commit: fa95695ecfd0a547efa6fe41b998a114b3b2aeee
Parents: 1402dfa
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Feb 1 22:33:38 2016 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Mon Feb 1 22:45:13 2016 +0000
----------------------------------------------------------------------
README.md | 25 ++++++++++++++++++++-----
1 file changed, 20 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn/blob/fa95695e/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 1b1f315..d267935 100644
--- a/README.md
+++ b/README.md
@@ -33,12 +33,27 @@ To run, you might:
pushd brooklyn-dist/usage/dist/target/brooklyn-dist/brooklyn/
bin/brooklyn launch
+For more on the code, sub-modules, not using sub-modules, and other topics, see below.
+
### Resources
-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 -->
+<!--- BROOKLYN_VERSION_BELOW -->
+The **Developer Guide** contains more detail on working with the codebase. It is available for [this version/branch -- 0.9.0-SNAPSHOT](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/) (permalink, also used below) or for [the latest released version](https://brooklyn.apache.org/v/latest/dev/).
+
+Useful topics include:
+
+<!--- BROOKLYN_VERSION_BELOW -->
+* working with the **[source code](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/code)**
+
+<!--- BROOKLYN_VERSION_BELOW -->
+* using **[git sub-modules](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/code/submodules.html)** effectively
+
+<!--- BROOKLYN_VERSION_BELOW -->
+* **[avoiding](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/code/no-submodules.html)** sub-modules
+
+<!--- BROOKLYN_VERSION_BELOW -->
+* **[project structure](https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/dev/code/structure.html)**
+
+<!--- BROOKLYN_VERSION_BELOW -->
* the **[people](https://brooklyn.apache.org/community/index.html)** behind Apache Brooklyn