README.md 4.8 KB
Newer Older
C
Chris Beams 已提交
1
## Spring Framework
C
Chris Beams 已提交
2 3 4 5 6 7
The Spring Framework provides a comprehensive programming and configuration
model for modern Java-based enterprise applications - on any kind of deployment
platform. A key element of Spring is infrastructural support at the application
level: Spring focuses on the "plumbing" of enterprise applications so that teams
can focus on application-level business logic, without unnecessary ties to
specific deployment environments.
C
Chris Beams 已提交
8

C
Chris Beams 已提交
9 10 11
The framework also serves as the foundation for [Spring Integration][], [Spring
Batch][] and the rest of the Spring [family of projects][]. Browse the
repositories under the [SpringSource organization][] on GitHub for a full list.
C
Chris Beams 已提交
12 13

## Downloading artifacts
C
Chris Beams 已提交
14 15 16
See [downloading Spring artifacts][] for Maven repository information. Unable to
use Maven or other transitive dependency management tools? See [building a
distribution with dependencies][].
C
Chris Beams 已提交
17 18

## Documentation
C
Chris Beams 已提交
19
See the current [Javadoc][] and [reference docs][].
C
Chris Beams 已提交
20 21

## Getting support
C
Chris Beams 已提交
22 23 24
Check out the [Spring forums][] and the [spring][spring tag] and
[spring-mvc][spring-mvc tag] tags on [Stack Overflow][]. [Commercial support][]
is available too.
C
Chris Beams 已提交
25 26

## Issue Tracking
C
Chris Beams 已提交
27 28 29 30 31
Report issues via the [Spring Framework JIRA]. Understand our issue management
process by reading about [the lifecycle of an issue][]. Think you've found a
bug? Please consider submitting a reproduction project via the
[spring-framework-issues][] GitHub repository. The [readme][] there provides
simple step-by-step instructions.
32

C
Chris Beams 已提交
33
## Building from source
C
Chris Beams 已提交
34 35
The Spring Framework uses a [Gradle][]-based build system. In the instructions
below, [`./gradlew`][] is invoked from the root of the source tree and serves as
C
Chris Beams 已提交
36 37 38 39
a cross-platform, self-contained bootstrap mechanism for the build.

### prerequisites

40
[Git][] and [OpenJDK 8 early access build 100 or later][JDK8 build]
41 42 43

Be sure that your `JAVA_HOME` environment variable points to the `jdk1.8.0` folder
extracted from the JDK download.
44 45 46 47

### check out sources
`git clone git://github.com/SpringSource/spring-framework.git`

48 49
### import sources into your IDE
Run `./import-into-eclipse.sh` or read `import-into-idea.md` as appropriate.
50 51
> **Note:** Per the prerequisites above, ensure that you have JDK 8 configured
properly in your IDE.
52 53 54 55

### install all spring-\* jars into your local Maven cache
`./gradlew install`

56 57
### compile and test, build all jars, distribution zips and docs
`./gradlew build`
58

C
Chris Beams 已提交
59 60
... and discover more commands with `./gradlew tasks`. See also the [Gradle
build and release FAQ][].
C
Chris Beams 已提交
61 62

## Contributing
63
[Pull requests][] are welcome; see the [contributor guidelines][] for details.
C
Chris Beams 已提交
64 65

## Staying in touch
C
Chris Beams 已提交
66 67 68
Follow [@springframework][] and its [team members][] on Twitter. In-depth
articles can be found at the SpringSource [team blog][], and releases are
announced via our [news feed][].
C
Chris Beams 已提交
69 70

## License
C
Chris Beams 已提交
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
The Spring Framework is released under version 2.0 of the [Apache License][].

[Spring Integration]: https://github.com/SpringSource/spring-integration
[Spring Batch]: https://github.com/SpringSource/spring-batch
[family of projects]: http://springsource.org/projects
[SpringSource organization]: https://github.com/SpringSource
[downloading Spring artifacts]: https://github.com/SpringSource/spring-framework/wiki/Downloading-Spring-artifacts
[building a distribution with dependencies]: https://github.com/SpringSource/spring-framework/wiki/Building-a-distribution-with-dependencies
[Javadoc]: http://static.springsource.org/spring-framework/docs/current/javadoc-api
[reference docs]: http://static.springsource.org/spring-framework/docs/current/spring-framework-reference
[Spring forums]: http://forum.springsource.org
[spring tag]: http://stackoverflow.com/questions/tagged/spring
[spring-mvc tag]: http://stackoverflow.com/questions/tagged/spring-mvc
[Stack Overflow]: http://stackoverflow.com/faq
[Commercial support]: http://springsource.com/support/springsupport
[Spring Framework JIRA]: http://jira.springsource.org/browse/SPR
[the lifecycle of an issue]: https://github.com/cbeams/spring-framework/wiki/The-Lifecycle-of-an-Issue
[spring-framework-issues]: https://github.com/SpringSource/spring-framework-issues#readme
[readme]: https://github.com/SpringSource/spring-framework-issues#readme
[Gradle]: http://gradle.org
[`./gradlew`]: http://vimeo.com/34436402
[Git]: http://help.github.com/set-up-git-redirect
93
[JDK8 build]: http://jdk8.java.net/download.html
C
Chris Beams 已提交
94 95
[Gradle build and release FAQ]: https://github.com/SpringSource/spring-framework/wiki/Gradle-build-and-release-FAQ
[Pull requests]: http://help.github.com/send-pull-requests
96
[contributor guidelines]: https://github.com/SpringSource/spring-framework/blob/master/CONTRIBUTING.md
C
Chris Beams 已提交
97
[@springframework]: http://twitter.com/springframework
98
[team members]: http://spring.io/team
C
Chris Beams 已提交
99 100 101
[team blog]: http://blog.springsource.org
[news feed]: http://www.springsource.org/news-events
[Apache License]: http://www.apache.org/licenses/LICENSE-2.0