|
|
|
|
Please read the
|
|
|
|
|
[Overview](https://docs.spring.io/spring/docs/current/spring-framework-reference/overview.html#spring-introduction)
|
|
|
|
|
in the reference documentation for a quick introduction.
|
|
|
|
|
|
|
|
|
|
This project is governed by the [Spring Code of Conduct](CODE_OF_CONDUCT.adoc).
|
|
|
|
|
By participating you are expected to uphold this code.
|
|
|
|
|
Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
|
|
|
|
|
|
|
|
|
|
For Maven repository information see [downloading Spring artifacts][], or if unable to
|
|
|
|
|
use Maven or other transitive dependency management tools, see
|
|
|
|
|
[building a distribution with dependencies][].
|
|
|
|
|
|
|
|
|
|
Documentation is available in the form of [reference docs][], [Javadoc][], and Github Wiki pages.
|
|
|
|
|
|
|
|
|
|
For contributing see the [contributor guidelines][] for details.
|
|
|
|
|
|
|
|
|
|
## Building from Source
|
|
|
|
|
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
|
|
|
|
|
a cross-platform, self-contained bootstrap mechanism for the build.
|
|
|
|
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
|
|
|
|
|
[Git][] and [JDK 8 update 20 or later][JDK8 build]
|
|
|
|
|
|
|
|
|
|
Be sure that your `JAVA_HOME` environment variable points to the `jdk1.8.0` folder
|
|
|
|
|
extracted from the JDK download.
|
|
|
|
|
|
|
|
|
|
### Check out sources
|
|
|
|
|
`git clone git@github.com:spring-projects/spring-framework.git`
|
|
|
|
|
|
|
|
|
|
### Import sources into your IDE
|
|
|
|
|
Run `./import-into-eclipse.sh` or read `import-into-idea.md` as appropriate.
|
|
|
|
|
> **Note:** Per the prerequisites above, ensure that you have JDK 8 configured properly in your IDE.
|
|
|
|
|
|
|
|
|
|
### Install all spring-\* jars into your local Maven cache
|
|
|
|
|
`./gradlew install`
|
|
|
|
|
|
|
|
|
|
### Compile and test; build all jars, distribution zips, and docs
|
|
|
|
|
`./gradlew build`
|
|
|
|
|
|
|
|
|
|
... and discover more commands with `./gradlew tasks`. See also the [Gradle
|
|
|
|
|
build and release FAQ][].
|
|
|
|
|
|
|
|
|
|
## Staying in Touch
|
|
|
|
|
Follow [@SpringCentral][] as well as [@SpringFramework][] and its [team members][]
|
|
|
|
|
on Twitter. In-depth articles can be found at [The Spring Blog][], and releases
|
|
|
|
|
are announced via our [news feed][].
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
The Spring Framework is released under version 2.0 of the [Apache License][].
|
|
|
|
|
|
|
|
|
|
[downloading Spring artifacts]: https://github.com/spring-projects/spring-framework/wiki/Downloading-Spring-artifacts
|
|
|
|
|
[building a distribution with dependencies]: https://github.com/spring-projects/spring-framework/wiki/Building-a-distribution-with-dependencies
|
|
|
|
|
[Javadoc]: http://docs.spring.io/spring-framework/docs/current/javadoc-api/
|
|
|
|
|
[reference docs]: http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/
|
|
|
|
|
[Spring Framework JIRA]: https://jira.spring.io/browse/SPR
|
|
|
|
|
[Gradle]: http://gradle.org
|
|
|
|
|
[`./gradlew`]: http://vimeo.com/34436402
|
|
|
|
|
[Git]: http://help.github.com/set-up-git-redirect
|
|
|
|
|
[JDK8 build]: http://www.oracle.com/technetwork/java/javase/downloads
|
|
|
|
|
[Gradle build and release FAQ]: https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ
|
|
|
|
|
[Pull requests]: https://help.github.com/categories/collaborating-on-projects-using-issues-and-pull-requests/
|
|
|
|
|
[contributor guidelines]: https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.adoc
|
|
|
|
|
[@SpringFramework]: https://twitter.com/springframework
|
|
|
|
|
[@SpringCentral]: https://twitter.com/springcentral
|
|
|
|
|
[team members]: https://twitter.com/springframework/lists/team/members
|
|
|
|
|
[The Spring Blog]: http://spring.io/blog/
|
|
|
|
|
[news feed]: http://spring.io/blog/category/news
|
|
|
|
|
[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
|
