Browse Source

Update README and remove .settings.xml where appropriate

pull/6/head
Dave Syer 9 years ago
parent
commit
043a965db3
  1. 66
      .settings.xml
  2. 24
      README.adoc
  3. 2
      docs/src/main/asciidoc/README.adoc

66
.settings.xml

@ -1,66 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<settings>
<servers>
<server>
<id>repo.spring.io</id>
<username>${env.CI_DEPLOY_USERNAME}</username>
<password>${env.CI_DEPLOY_PASSWORD}</password>
</server>
</servers>
<profiles>
<profile>
<!--
N.B. this profile is only here to support users and IDEs that do not use Maven 3.3.
It isn't needed on the command line if you use the wrapper script (mvnw) or if you use
a native Maven with the right version. Eclipse users should points their Maven tooling to
this settings file, or copy the profile into their ~/.m2/settings.xml.
-->
<id>spring</id>
<activation><activeByDefault>true</activeByDefault></activation>
<repositories>
<repository>
<id>spring-snapshots</id>
<name>Spring Snapshots</name>
<url>http://repo.spring.io/libs-snapshot-local</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>http://repo.spring.io/libs-milestone-local</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>spring-releases</id>
<name>Spring Releases</name>
<url>http://repo.spring.io/release</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>spring-snapshots</id>
<name>Spring Snapshots</name>
<url>http://repo.spring.io/libs-snapshot-local</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>http://repo.spring.io/libs-milestone-local</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
</settings>

24
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://www.springsource.com/developer/sts[Spring Tools Suite] or
http://eclipse.org[Eclipse] when working with the code. We use the 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 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 ==== Importing into eclipse with m2eclipse
We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with 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 eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
marketplace". marketplace".
Unfortunately m2e does not yet support Maven 3.3, so once the projects NOTE: Older versions of m2e do not support Maven 3.3, so once the
are imported into Eclipse you will also need to tell m2eclipse to use projects are imported into Eclipse you will also need to tell
the `.settings.xml` file for the projects. If you do not do this you m2eclipse to use the right profile for the projects. If you
may see many different errors related to the POMs in the see many different errors related to the POMs in the projects, check
projects. Open your Eclipse preferences, expand the Maven that you have an up to date installation. If you can't upgrade m2e,
preferences, and select User Settings. In the User Settings field add the "spring" profile to your `settings.xml`. Alternatively you can
click Browse and navigate to the Spring Cloud project you imported copy the repository settings from the "spring" profile of the parent
selecting the `.settings.xml` file in that project. Click Apply and pom into your `settings.xml`.
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 ==== Importing into eclipse without m2eclipse
If you prefer not to use m2eclipse you can generate eclipse project metadata using the 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` The generated eclipse projects can be imported by selecting `import existing projects`
from the `file` menu. from the `file` menu.
==== Adding Project Lombok Agent ==== Adding Project Lombok Agent
Spring Cloud uses http://projectlombok.org/features/index.html[Project Lombok] 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 ==== Importing into other IDEs
Maven is well supported by most Java IDEs. Refer to you vendor documentation. Maven is well supported by most Java IDEs. Refer to you vendor documentation.
== Contributing == Contributing
Spring Cloud is released under the non-restrictive Apache 2.0 license, Spring Cloud is released under the non-restrictive Apache 2.0 license,

2
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-jdk8.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building-lombok.adoc[]
== Contributing == Contributing
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[]

Loading…
Cancel
Save