$ ./mvnw install+
diff --git a/reference/html/README.html b/reference/html/README.html index 407d49ee..de9e81fa 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -126,7 +126,18 @@ $(addBlockSwitches);
PropertySourceLocator, where you need to add t
Unresolved directive in spring-cloud-kubernetes.adoc - include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building.adoc[]
+To build the source you will need to install JDK 1.7.
+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
+$ ./mvnw install+
| + + | +
+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.
+ |
+
| + + | +
+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’re related to setting git
+credentials and you already have those.
The projects that require middleware generally include a
+docker-compose.yml, so consider using
+Docker Compose to run the middeware servers
+in Docker containers. See the README in the
+scripts demo
+repository for specific instructions about the common cases of mongo,
+rabbit and redis.
| + + | +
+If all else fails, build with the command from .travis.yml (usually
+./mvnw install).
+ |
+
The spring-cloud-build module has a "docs" profile, and if you switch
+that on it will try to build asciidoc sources from
+src/main/asciidoc. As part of that process it will look for a
+README.adoc and process it by loading all the includes, but not
+parsing or rendering it, just copying it to ${main.basedir}
+(defaults to ${basedir}, i.e. the root of the project). If there are
+any changes in the README it will then show up after a Maven build as
+a modified file in the correct place. Just commit it and push the change.
If you don’t have an IDE preference we would recommend that you use +Spring Tools Suite or +Eclipse when working with the code. We use the +m2eclipse eclipse plugin for maven support. Other IDEs and tools +should also work without issue as long as they use Maven 3.3.3 or better.
+We recommend the m2eclipse eclipse plugin when working with +eclipse. If you don’t already have m2eclipse installed it is available from the "eclipse +marketplace".
+| + + | +
+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.
+ |
+
If you prefer not to use m2eclipse you can generate eclipse project metadata using the +following command:
+$ ./mvnw eclipse:eclipse+
The generated eclipse projects can be imported by selecting import existing projects
+from the file menu.