[ALL] update README file in each repo to be appropriate to that repo, with building instructions
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/fef8a365 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/fef8a365 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/fef8a365 Branch: refs/heads/master Commit: fef8a36541c31ffcef168ab474ebaf980396854b Parents: 78ea56a Author: Alex Heneveld <[email protected]> Authored: Fri Dec 18 22:57:12 2015 +0000 Committer: Alex Heneveld <[email protected]> Committed: Mon Dec 21 16:43:37 2015 +0000 ---------------------------------------------------------------------- README.md | 13 +++++++------ brooklyn-dist/README.md | 19 +++---------------- brooklyn-library/README.md | 20 ++++---------------- brooklyn-server/README.md | 20 +++----------------- brooklyn-ui/README.md | 21 +++++---------------- 5 files changed, 22 insertions(+), 71 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/fef8a365/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 6b66cf2..020e2ae 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ # [](http://brooklyn.apache.org/) -### Apache Brooklyn helps to model, deploy, and manage systems. +### Apache Brooklyn **Incubator** Historic Repo -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. +This is the historical **incubator** repo for Apache Brooklyn. -For more information see **[brooklyn.apache.org](https://brooklyn.apache.org/)**. +## Brooklyn has graduated. Visit us [here](http://github.com/apache/brooklyn/). + +The sub-directories in this project correspond to multiple separate repositories in apache. +(The link above to `brooklyn/` started life exactly as a copy of [`brooklyn/`](brooklyn/) +in this folder, as an uber-project for the others, including the `server` and the `ui`.) ### To Build @@ -17,5 +20,3 @@ The code can be built with a: This creates a build in `usage/dist/target/brooklyn-dist`. Run with `bin/brooklyn launch`. -The **[developer guide](https://brooklyn.apache.org/v/latest/dev/)** -has more information about the source code. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/fef8a365/brooklyn-dist/README.md ---------------------------------------------------------------------- diff --git a/brooklyn-dist/README.md b/brooklyn-dist/README.md index 6b66cf2..0b34dc4 100644 --- a/brooklyn-dist/README.md +++ b/brooklyn-dist/README.md @@ -1,21 +1,8 @@ # [](http://brooklyn.apache.org/) -### Apache Brooklyn helps to model, deploy, and manage systems. +### Distribution Sub-Project for Apache Brooklyn -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. +This repo contains modules for creating the distributable binary +combining the `server`, the `ui`, and other elements in other Brooklyn repos. -For more information see **[brooklyn.apache.org](https://brooklyn.apache.org/)**. - - -### To Build - -The code can be built with a: - - mvn clean install - -This creates a build in `usage/dist/target/brooklyn-dist`. Run with `bin/brooklyn launch`. - -The **[developer guide](https://brooklyn.apache.org/v/latest/dev/)** -has more information about the source code. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/fef8a365/brooklyn-library/README.md ---------------------------------------------------------------------- diff --git a/brooklyn-library/README.md b/brooklyn-library/README.md index 6b66cf2..f2fd833 100644 --- a/brooklyn-library/README.md +++ b/brooklyn-library/README.md @@ -1,21 +1,9 @@ # [](http://brooklyn.apache.org/) -### Apache Brooklyn helps to model, deploy, and manage systems. +### Library of Entities for Apache Brooklyn -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. +This sub-project contains various entities not *needed* for Brooklyn, +but useful in practice as building blocks, including entities for webapps, +datastores, and more. -For more information see **[brooklyn.apache.org](https://brooklyn.apache.org/)**. - - -### To Build - -The code can be built with a: - - mvn clean install - -This creates a build in `usage/dist/target/brooklyn-dist`. Run with `bin/brooklyn launch`. - -The **[developer guide](https://brooklyn.apache.org/v/latest/dev/)** -has more information about the source code. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/fef8a365/brooklyn-server/README.md ---------------------------------------------------------------------- diff --git a/brooklyn-server/README.md b/brooklyn-server/README.md index 6b66cf2..07f69e6 100644 --- a/brooklyn-server/README.md +++ b/brooklyn-server/README.md @@ -1,21 +1,7 @@ # [](http://brooklyn.apache.org/) -### Apache Brooklyn helps to model, deploy, and manage systems. +### Apache Brooklyn Server Sub-Project -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/)**. - - -### To Build - -The code can be built with a: - - mvn clean install - -This creates a build in `usage/dist/target/brooklyn-dist`. Run with `bin/brooklyn launch`. - -The **[developer guide](https://brooklyn.apache.org/v/latest/dev/)** -has more information about the source code. +This repo contains the core elements to run a Brooklyn server, +from the API and utils through to the core implementation and the REST server. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/fef8a365/brooklyn-ui/README.md ---------------------------------------------------------------------- diff --git a/brooklyn-ui/README.md b/brooklyn-ui/README.md index 6b66cf2..057c206 100644 --- a/brooklyn-ui/README.md +++ b/brooklyn-ui/README.md @@ -1,21 +1,10 @@ # [](http://brooklyn.apache.org/) -### Apache Brooklyn helps to model, deploy, and manage systems. +### Apache Brooklyn UI Sub-Project -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. +This repo contains the JS GUI for Apache Brooklyn. -For more information see **[brooklyn.apache.org](https://brooklyn.apache.org/)**. - - -### To Build - -The code can be built with a: - - mvn clean install - -This creates a build in `usage/dist/target/brooklyn-dist`. Run with `bin/brooklyn launch`. - -The **[developer guide](https://brooklyn.apache.org/v/latest/dev/)** -has more information about the source code. +It is pure Javascript, but for legacy reasons it expects the REST endpoint at the same endpoint, +so currently the easiest way to run it is using the BrooklynJavascriptGuiLauncher java launcher +in `brooklyn-server`.
