From 043a965db39b9505d8a0dfc8250fd4a2bcddf158 Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Thu, 12 May 2016 10:24:08 +0100 Subject: [PATCH] Update README and remove .settings.xml where appropriate --- .settings.xml | 66 ------------------------------ README.adoc | 24 +++++------ docs/src/main/asciidoc/README.adoc | 2 + 3 files changed, 13 insertions(+), 79 deletions(-) delete mode 100644 .settings.xml diff --git a/.settings.xml b/.settings.xml deleted file mode 100644 index 6c355129..00000000 --- a/.settings.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - repo.spring.io - ${env.CI_DEPLOY_USERNAME} - ${env.CI_DEPLOY_PASSWORD} - - - - - - spring - true - - - spring-snapshots - Spring Snapshots - http://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - http://repo.spring.io/libs-milestone-local - - false - - - - spring-releases - Spring Releases - http://repo.spring.io/release - - false - - - - - - spring-snapshots - Spring Snapshots - http://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - http://repo.spring.io/libs-milestone-local - - false - - - - - - diff --git a/README.adoc b/README.adoc index a34519e3..40aa306d 100644 --- a/README.adoc +++ b/README.adoc @@ -83,24 +83,21 @@ If you don't have an IDE preference we would recommend that you use http://www.springsource.com/developer/sts[Spring Tools Suite] or http://eclipse.org[Eclipse] when working with the code. We use the http://eclipse.org/m2e/[m2eclipe] eclipse plugin for maven support. Other IDEs and tools -should also work without issue. +should also work without issue as long as they use Maven 3.3.3 or better. ==== Importing into eclipse with m2eclipse We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with 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 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`. +NOTE: Older versions of m2e do not support Maven 3.3, so once the +projects are imported into Eclipse you will also need to tell +m2eclipse to use the right profile for the projects. If you +see many different errors related to the POMs in the projects, check +that you have an up to date installation. If you can't upgrade m2e, +add the "spring" profile to your `settings.xml`. Alternatively you can +copy the repository settings from the "spring" profile of the parent +pom into your `settings.xml`. ==== Importing into eclipse without m2eclipse If you prefer not to use m2eclipse you can generate eclipse project metadata using the @@ -114,6 +111,8 @@ following command: The generated eclipse projects can be imported by selecting `import existing projects` from the `file` menu. + + ==== Adding Project Lombok Agent Spring Cloud uses http://projectlombok.org/features/index.html[Project Lombok] @@ -148,7 +147,6 @@ enabled. Intellij 14.1+ requires some configuration to ensure these are setup pr ==== Importing into other IDEs Maven is well supported by most Java IDEs. Refer to you vendor documentation. - == Contributing Spring Cloud is released under the non-restrictive Apache 2.0 license, diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index e648be30..fa878819 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -17,6 +17,8 @@ include::intro.adoc[] include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building-jdk8.adoc[] +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building-lombok.adoc[] + == Contributing include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[]