From 97e9499b88a955a5b7667e886d9dab9f4c0f4996 Mon Sep 17 00:00:00 2001 From: Gunnar Hillert Date: Tue, 16 Aug 2011 09:44:50 -0400 Subject: [PATCH 1/4] #INT-2052 - renamed readme.txt to README.md to allow for Markdown styling --- readme.txt => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename readme.txt => README.md (100%) diff --git a/readme.txt b/README.md similarity index 100% rename from readme.txt rename to README.md From 5316b118053edd860f28dbc4327910226ce10086 Mon Sep 17 00:00:00 2001 From: Gunnar Hillert Date: Tue, 16 Aug 2011 10:28:01 -0400 Subject: [PATCH 2/4] #INT-2052 - Formatted README.md --- README.md | 52 +++++++++++++++++++++++++++++++--------------------- 1 file changed, 31 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index ee3401143f..8d0bbf723e 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,50 @@ -============================== Spring Integration ============================= +Spring Integration +================== + +# Checking out and Building + To check out the project and build from source, do the following: - git clone --recursive git://git.springsource.org/spring-integration/spring-integration.git - cd spring-integration - ./gradlew build + git clone --recursive git://git.springsource.org/spring-integration/spring-integration.git + cd spring-integration + ./gradlew build -Note: the --recursive switch above is important, as spring-integration uses -git submodules, which must themselves be cloned and initialized. If --recursive -is omitted, doing so becomes a multi-step process. +> Note: the --recursive switch above is important, as spring-integration uses +> git submodules, which must themselves be cloned and initialized. If --recursive +> is omitted, doing so becomes a multi-step process. -If you encounter heap space errors during the build, increase the heap size for -gradle: - GRADLE_OPTS="-Xmx1024m" +If you encounter heap space errors during the build, increase the heap size for Gradle: + + GRADLE_OPTS="-Xmx1024m" + +# Using Eclipse -------------------------------------------------------------------------------- To generate Eclipse metadata (.classpath and .project files), do the following: - ./gradlew eclipse + ./gradlew eclipse Once complete, you may then import the projects into Eclipse as usual: - File -> Import -> Existing projects into workspace + *File -> Import -> Existing projects into workspace* -Browse to the 'spring-integration' root directory. All projects should import +Browse to the *'spring-integration'* root directory. All projects should import free of errors. -------------------------------------------------------------------------------- +# Using IntelliJ IDEA + To generate IDEA metadata (.iml and .ipr files), do the following: - ./gradlew idea + ./gradlew idea + +# Generating JavaDoc -------------------------------------------------------------------------------- To build the JavaDoc, do the following from within the root directory: - ./gradlew :docs:api + ./gradlew :docs:api -The result will be available in 'docs/build/api'. +The result will be available in **'docs/build/api'**. -###### OSGI Notes ###### +# OSGI Notes 1. Dependency on Third Party Bundles Some adapters depend on third party libraries (bundles). @@ -59,4 +66,7 @@ The result will be available in 'docs/build/api'. For example: org.osgi.framework.bootdelegation=com.sun.*,org.w3c.*. . . . -=============================================================================== + +# Resources + +For more information, please visit the Spring Integration website at: [http://www.springsource.org/spring-integration](http://www.springsource.org/spring-integration) \ No newline at end of file From 029761404354789b1f91943b4751ee39c8127770 Mon Sep 17 00:00:00 2001 From: Gunnar Hillert Date: Tue, 16 Aug 2011 10:37:44 -0400 Subject: [PATCH 3/4] #INT-2052 - Sourounded --recursive with to escape -- in README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8d0bbf723e..a1293700c5 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ Spring Integration To check out the project and build from source, do the following: - git clone --recursive git://git.springsource.org/spring-integration/spring-integration.git + git clone --recursive git://github.com/SpringSource/spring-integration.git cd spring-integration ./gradlew build -> Note: the --recursive switch above is important, as spring-integration uses -> git submodules, which must themselves be cloned and initialized. If --recursive +> Note: the **--recursive** switch above is important, as spring-integration uses +> git submodules, which must themselves be cloned and initialized. If **--recursive** > is omitted, doing so becomes a multi-step process. If you encounter heap space errors during the build, increase the heap size for Gradle: From f0d42d1f910bd4347f309dbfe28365aa3d99503c Mon Sep 17 00:00:00 2001 From: Gunnar Hillert Date: Tue, 16 Aug 2011 11:29:31 -0400 Subject: [PATCH 4/4] #INT-2052 - Fixed some wording in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a1293700c5..65998a57c7 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ To check out the project and build from source, do the following: ./gradlew build > Note: the **--recursive** switch above is important, as spring-integration uses -> git submodules, which must themselves be cloned and initialized. If **--recursive** -> is omitted, doing so becomes a multi-step process. +> *git submodules*, which must themselves be cloned and initialized. If **--recursive** +> is omitted, the checkout becomes a multi-step process. If you encounter heap space errors during the build, increase the heap size for Gradle: