Permalink
Browse files

Merge pull request #42 from ghillert/AMQP-83

  • Loading branch information...
2 parents 3795279 + 5c719a4 commit 745894580a05f599620adce98876a9336051dc4e @garyrussell garyrussell committed Jun 19, 2012
Showing with 1,003 additions and 3,285 deletions.
  1. +13 −8 .gitignore
  2. +84 −21 README.md
  3. +353 −0 build.gradle
  4. +1 −0 gradle.properties
  5. BIN gradle/wrapper/gradle-wrapper.jar
  6. +6 −0 gradle/wrapper/gradle-wrapper.properties
  7. +164 −0 gradlew
  8. +90 −0 gradlew.bat
  9. +0 −352 pom.xml
  10. +81 −0 publish-maven.gradle
  11. +0 −93 release-process.md
  12. +6 −0 settings.gradle
  13. +0 −11 spring-amqp-core/template.mf
  14. +0 −570 spring-amqp-parent/pom.xml
  15. +0 −8 spring-erlang/template.mf
  16. +0 −19 spring-rabbit/template.mf
  17. +25 −0 src/api/overview.html
  18. +0 −79 src/assembly/distribution.xml
  19. +122 −0 src/dist/README.md
  20. 0 src/{assembly → dist}/apache-license.txt
  21. 0 src/{assembly → dist}/epl-license.txt
  22. 0 src/{assembly → dist}/notice.txt
  23. +0 −8 src/docbkx/preface.xml
  24. +0 −35 src/docbkx/resources/css/highlight.css
  25. +0 −421 src/docbkx/resources/css/html.css
  26. +0 −99 src/docbkx/resources/css/stylesheet.css
  27. BIN src/docbkx/resources/images/callouts/1.png
  28. BIN src/docbkx/resources/images/callouts/10.png
  29. BIN src/docbkx/resources/images/callouts/11.png
  30. BIN src/docbkx/resources/images/callouts/12.png
  31. BIN src/docbkx/resources/images/callouts/13.png
  32. BIN src/docbkx/resources/images/callouts/14.png
  33. BIN src/docbkx/resources/images/callouts/15.png
  34. BIN src/docbkx/resources/images/callouts/2.png
  35. BIN src/docbkx/resources/images/callouts/3.png
  36. BIN src/docbkx/resources/images/callouts/4.png
  37. BIN src/docbkx/resources/images/callouts/5.png
  38. BIN src/docbkx/resources/images/callouts/6.png
  39. BIN src/docbkx/resources/images/callouts/7.png
  40. BIN src/docbkx/resources/images/callouts/8.png
  41. BIN src/docbkx/resources/images/callouts/9.png
  42. BIN src/docbkx/resources/images/xdev-spring_logo.jpg
  43. +0 −417 src/docbkx/resources/xsl/fopdf.xsl
  44. +0 −91 src/docbkx/resources/xsl/html.xsl
  45. +0 −136 src/docbkx/resources/xsl/html/html_chunk.xsl
  46. +0 −61 src/docbkx/resources/xsl/html/titlepage.xml
  47. +0 −208 src/docbkx/resources/xsl/html_chunk.xsl
  48. +0 −518 src/docbkx/resources/xsl/pdf/fopdf.xsl
  49. +0 −101 src/docbkx/resources/xsl/pdf/titlepage.xml
  50. +2 −3 src/{docbkx → reference/docbook}/amqp.xml
  51. +2 −3 src/{docbkx → reference/docbook}/bibliography.xml
  52. +2 −3 src/{docbkx → reference/docbook}/erlang.xml
  53. +2 −3 src/{docbkx → reference/docbook}/further-reading.xml
  54. BIN src/{docbkx/resources → reference/docbook}/images/logo.png
  55. +26 −8 src/{docbkx → reference/docbook}/index.xml
  56. +18 −0 src/reference/docbook/preface.xml
  57. +2 −3 src/{docbkx → reference/docbook}/quick-tour.xml
  58. +2 −3 src/{docbkx → reference/docbook}/sample-apps.xml
  59. +2 −3 src/{docbkx → reference/docbook}/si-amqp.xml
View
@@ -1,14 +1,19 @@
-target
-bin
+*.iml
+*.ipr
+*.iws
+*.swp
+*/src/main/java/META-INF
+.ant-targets-build.xml
.classpath
+.idea
+.gradle
.project
.settings
.springBeans
-.ant-targets-build.xml
-src/ant/.ant-targets-upload-dist.xml
-*.swp
-*/src/main/java/META-INF
+bin
+build
+.DS_Store
erl_crash.dump
nohup.out
-.idea
-*.iml
+src/ant/.ant-targets-upload-dist.xml
+target
View
105 README.md
@@ -1,40 +1,99 @@
-This project provides support for using Spring and Java with AMQP, and in particular RabbitMQ.
+Spring AMQP
+===========
-# Getting Started
+This project provides support for using Spring and Java with [AMQP](http://www.amqp.org/), and in particular [RabbitMQ](http://www.rabbitmq.com/).
-Clone from GIT and then use Maven (2.2.*):
+# Checking out and Building
- $ git clone ...
- $ mvn install -P bootstrap
+To check out the project from [GitHub](https://github.com/SpringSource/spring-amqp) and build from source using [Gradle](http://gradle.org/), do the following:
-Use the `bootstrap` profile only the first time - it enables some
-repositories that can't be exposed in the poms by default.
+ git clone git://github.com/SpringSource/spring-amqp.git
+ cd spring-amqp
+ ./gradlew build
-SpringSource ToolSuite users (or Eclipse users with the latest
-m2eclipse plugin) can import the projects as existing Eclipse
-projects. There are plenty of interesting integration tests (names
-ending with `IntegrationTests`) to show the features of the
-framework. Sample applications can be found in the [Spring AMQP
-Samples](http://github.com/SpringSource/spring-amqp-samples) project.
+If you encounter out of memory errors during the build, increase available heap and permgen for Gradle:
-Spring AMQP is released under the terms of the Apache Software License Version 2.0 (see license.txt).
+ GRADLE_OPTS='-XX:MaxPermSize=1024m -Xmx1024m'
+
+To build and install jars into your local Maven cache:
+
+ ./gradlew install
+
+To build api Javadoc (results will be in `build/api`):
+
+ ./gradlew api
+
+To build reference documentation (results will be in `build/reference`):
+
+ ./gradlew reference
+
+To build complete distribution including `-dist`, `-docs`, and `-schema` zip files (results will be in `build/distributions`)
+
+ ./gradlew dist
+
+To analyze and gather metrics using [Sonar](http://www.sonarsource.org/):
+
+ ./gradlew clean build sonar
+
+(Please make sure that you have Sonar running, e.g. on localhost port 9000)
+
+
+# Using Eclipse
+
+To generate Eclipse metadata (.classpath and .project files), do the following:
+ ./gradlew eclipse
+
+Once complete, you may then import the projects into Eclipse as usual:
+
+*File -> Import -> Existing projects into workspace*
+
+Browse to the *'spring-amqp'* root directory. All projects should import free of errors.
+
+# Using SpringSource Tool Suite™ (STS)
+
+Using the STS Gradle Support, you can directly import Gradle projects, without having to generate Eclipse metadata first (since STS 2.7.M1). Please make sure you have the Gradle STS Extension installed - Please see the [installation instructions](http://static.springsource.org/sts/docs/latest/reference/html/gradle/installation.html) for details.
+
+1. Select *File -> Import -> Gradle Project*
+2. Browse to the Spring AMQP Root Folder
+3. Click on **Build Model**
+4. Select the projects you want to import
+5. Press **Finish**
+
+# Using IntelliJ IDEA
+
+To generate IDEA metadata (.iml and .ipr files), do the following:
+
+ ./gradlew idea
## Distribution Contents
-The binary JARs are available in the 'dist' directory, and the source JARs are in the 'src' directory. The reference manual and javadoc are located in the 'docs' directory.
+If you downloaded the full Spring AMQP distribution or if you created the distribution using `./gradlew dist`, you will see the following directory structure:
+
+ ├── README.md
+ ├── apache-license.txt
+ ├── docs
+ │ ├── api
+ │ └── reference
+ ├── epl-license.txt
+ ├── libs
+ ├── notice.txt
+ └── schema
+ └── rabbit
+
+The binary JARs and the source code are available in the **libs**. The reference manual and javadocs are located in the **docs** directory.
## Changelog
Lists of issues addressed per release can be found in [JIRA](https://jira.springsource.org/browse/AMQP#selectedTab=com.atlassian.jira.plugin.system.project%3Aversions-panel).
## Additional Resources
-* Spring AMQP Homepage: [http://www.springsource.org/spring-amqp]
-* Spring AMQP Source: [http://github.com/SpringSource/spring-amqp]
-* Spring AMQP Samples: [http://github.com/SpringSource/spring-amqp-samples]
-* Spring AMQP Forum: [http://forum.springsource.org/forumdisplay.php?f=74]
-
+* [Spring AMQP Homepage](http://www.springsource.org/spring-amqp)
+* [Spring AMQP Source](http://github.com/SpringSource/spring-amqp)
+* [Spring AMQP Samples](http://github.com/SpringSource/spring-amqp-samples)
+* [Spring AMQP Forum](http://forum.springsource.org/forumdisplay.php?f=74)
+* [StackOverflow](http://stackoverflow.com/questions/tagged/spring-amqp)
# Contributing to Spring AMQP
@@ -45,7 +104,7 @@ Here are some ways for you to get involved in the community:
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, please reference a JIRA ticket as well covering the specific issue you are addressing.
* Watch for upcoming articles on Spring by [subscribing](http://www.springsource.org/node/feed) to springframework.org
-Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
+Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
## Code Conventions and Housekeeping
None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.
@@ -57,3 +116,7 @@ None of these is essential for a pull request, but they will all help. They can
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
* A few unit tests would help a lot as well - someone has to do it.
* If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
+
+# License
+
+Spring AMQP is released under the terms of the Apache Software License Version 2.0 (see license.txt).
Oops, something went wrong.

0 comments on commit 7458945

Please sign in to comment.