From adcd4a83ac6bcad2bb07728a9a1533a77a84cbfa Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Fri, 14 Aug 2015 11:09:51 +0100 Subject: [PATCH] Update readmes --- README.adoc | 59 +++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 41 insertions(+), 18 deletions(-) diff --git a/README.adoc b/README.adoc index a800d96d..f0f513fc 100644 --- a/README.adoc +++ b/README.adoc @@ -21,35 +21,47 @@ Extract files into JDK/jre/lib/security folder (whichever version of JRE/JDK x64 === Basic Compile and Test -To build the source you will need to install -http://maven.apache.org/run-maven/index.html[Apache Maven] v3.0.6 or above and JDK {jdkversion}. +To build the source you will need to install JDK {jdkversion}. Spring Cloud uses Maven for most build-related activities, and you should be able to get off the ground quite quickly by cloning the project you are interested in and typing ---- -$ mvn install -s .settings.xml +$ ./mvnw install ---- -NOTE: You may need to increase the amount of memory available to Maven by setting -a `MAVEN_OPTS` environment variable with the value `-Xmx512m -XX:MaxPermSize=128m` +NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command +in place of `./mvnw` in the examples below. If you do that you also +might need to add `-P spring` if your local Maven settings do not +contain repository declarations for spring pre-release artifacts. -The `.settings.xml` is only required the first time (or after updates -to dependencies). It is there to provide repository declarations so -that those do not need to be hard coded in the project poms. +NOTE: Be aware that you might need to increase the amount of memory +available to Maven by setting a `MAVEN_OPTS` environment variable with +a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in +the `.mvn` configuration, so if you find you have to do it to make a +build succeed, please raise a ticket to get the settings added to +source control. For hints on how to build the project look in `.travis.yml` if there is one. There should be a "script" and maybe "install" command. Also look at the "services" section to see if any services need to be running locally (e.g. mongo or rabbit). Ignore the git-related bits -that you might find in "before_install" since they will be able git +that you might find in "before_install" since they're related to setting git credentials and you already have those. -If you need mongo, rabbit or redis, see the README in the https://github.com/spring-cloud-samples/scripts[scripts -demo repository] for -instructions. For example consider using the "fig.yml" with -http://www.fig.sh/[Fig] to run them in Docker containers. +The projects that require middleware generally include a +`docker-compose.yml`, so consider using +http://compose.docker.io/[Docker Compose] to run the middeware servers +in Docker containers. See the README in the +https://github.com/spring-cloud-samples/scripts[scripts demo +repository] for specific instructions about the common cases of mongo, +rabbit and redis. + +NOTE: migration to the Maven wrapper (`.mvnw`) is underway. If you +find a project that doesn't have it yet, raise an issue to get it +added, and build with the command from `.travis.yml` (usually +`mvn install -s .settings.xml`). === Documentation @@ -74,13 +86,25 @@ We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working w eclipse. If you don't already have m2eclipse installed it is available from the "eclipse marketplace". +Unfortunately m2e does not yet support Maven 3.3, so once the projects +are imported into Eclipse you will also need to tell m2eclipse to use +the `.settings.xml` file for the projects. If you do not do this you +may see errors many different errors related to the POMs in the +projects. Open your Eclipse preferences, expand the Maven +preferences, and select User Settings. In the User Settings field +click Browse and navigate to the Spring Cloud project you imported +selecting the `.settings.xml` file in that project. Click Apply and +then OK to save the preference changes. + +NOTE: Alternatively you can copy the repository settings from https://github.com/spring-cloud/spring-cloud-build/blob/master/.settings.xml[`.settings.xml`] into your own `~/.m2/settings.xml`. + ==== Importing into eclipse without m2eclipse If you prefer not to use m2eclipse you can generate eclipse project metadata using the following command: [indent=0] ---- - $ mvn eclipse:eclipse + $ ./mvnw eclipse:eclipse ---- The generated eclipse projects can be imported by selecting `import existing projects` @@ -88,9 +112,8 @@ from the `file` menu. ==== Adding Project Lombok Agent -Spring Cloud uses [Project -Lombok](http://projectlombok.org/features/index.html) to generate -getters and setters etc. Compiling from the command line this +Spring Cloud uses http://projectlombok.org/features/index.html[Project Lombok] +to generate getters and setters etc. Compiling from the command line this shouldn't cause any problems, but in an IDE you need to add an agent to the JVM. Full instructions can be found in the Lombok website. The sign that you need to do this is a lot of compiler errors to do with @@ -150,4 +173,4 @@ added after the original pull request but before a merge. other target branch in the main project). * When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit - message (where XXXX is the issue number). + message (where XXXX is the issue number). \ No newline at end of file