root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Polish formatting and update links in README

This commit is contained in:
Sam Brannen 2014-02-28 16:05:49 +01:00
parent 035bac025a
commit 57ecb9f307
1 changed files with 33 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -7,10 +7,10 @@ can focus on application-level business logic, without unnecessary ties to
specific deployment environments. specific deployment environments.
The framework also serves as the foundation for [Spring Integration][], [Spring The framework also serves as the foundation for [Spring Integration][], [Spring
Batch][] and the rest of the Spring [family of projects][]. Browse the Batch][] and the rest of the Spring [family of projects][]. Browse the repositories
repositories under the [SpringSource organization][] on GitHub for a full list. under the [Spring organization][] on GitHub for a full list.
## Downloading artifacts ## Downloading Artifacts
See [downloading Spring artifacts][] for Maven repository information. Unable to See [downloading Spring artifacts][] for Maven repository information. Unable to
use Maven or other transitive dependency management tools? See [building a use Maven or other transitive dependency management tools? See [building a
distribution with dependencies][]. distribution with dependencies][].
@ -18,7 +18,7 @@ distribution with dependencies][].
## Documentation ## Documentation
See the current [Javadoc][] and [reference docs][]. See the current [Javadoc][] and [reference docs][].
## Getting support ## Getting Support
Check out the [Spring forums][] and the [spring][spring tag] and Check out the [Spring forums][] and the [spring][spring tag] and
[spring-mvc][spring-mvc tag] tags on [Stack Overflow][]. [Commercial support][] [spring-mvc][spring-mvc tag] tags on [Stack Overflow][]. [Commercial support][]
is available too. is available too.
@ -30,30 +30,29 @@ bug? Please consider submitting a reproduction project via the
[spring-framework-issues][] GitHub repository. The [readme][] there provides [spring-framework-issues][] GitHub repository. The [readme][] there provides
simple step-by-step instructions. simple step-by-step instructions.
## Building from source ## Building from Source
The Spring Framework uses a [Gradle][]-based build system. In the instructions 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 below, [`./gradlew`][] is invoked from the root of the source tree and serves as
a cross-platform, self-contained bootstrap mechanism for the build. a cross-platform, self-contained bootstrap mechanism for the build.
### prerequisites ### Prerequisites
[Git][] and [OpenJDK 8 early access build 100 or later][JDK8 build] [Git][] and [OpenJDK 8 early access build 100 or later][JDK8 build]
Be sure that your `JAVA_HOME` environment variable points to the `jdk1.8.0` folder Be sure that your `JAVA_HOME` environment variable points to the `jdk1.8.0` folder
extracted from the JDK download. extracted from the JDK download.
### check out sources ### Check out sources
`git clone git://github.com/SpringSource/spring-framework.git` `git clone git@github.com:spring-projects/spring-framework.git`
### import sources into your IDE ### Import sources into your IDE
Run `./import-into-eclipse.sh` or read `import-into-idea.md` as appropriate. 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 > **Note:** Per the prerequisites above, ensure that you have JDK 8 configured properly in your IDE.
properly in your IDE.
### install all spring-\* jars into your local Maven cache ### Install all spring-\* jars into your local Maven cache
`./gradlew install` `./gradlew install`
### compile and test, build all jars, distribution zips and docs ### Compile and test; build all jars, distribution zips, and docs
`./gradlew build` `./gradlew build`
... and discover more commands with `./gradlew tasks`. See also the [Gradle ... and discover more commands with `./gradlew tasks`. See also the [Gradle
@ -62,40 +61,40 @@ build and release FAQ][].
## Contributing ## Contributing
[Pull requests][] are welcome; see the [contributor guidelines][] for details. [Pull requests][] are welcome; see the [contributor guidelines][] for details.
## Staying in touch ## Staying in Touch
Follow [@springframework][] and its [team members][] on Twitter. In-depth Follow [@springframework][] and its [team members][] on Twitter. In-depth
articles can be found at the SpringSource [team blog][], and releases are articles can be found at [The Spring Blog][], and releases are announced via
announced via our [news feed][]. our [news feed][].
## License ## License
The Spring Framework is released under version 2.0 of the [Apache License][]. The Spring Framework is released under version 2.0 of the [Apache License][].
[Spring Integration]: https://github.com/SpringSource/spring-integration [Spring Integration]: https://github.com/spring-projects/spring-integration
[Spring Batch]: https://github.com/SpringSource/spring-batch [Spring Batch]: https://github.com/spring-projects/spring-batch
[family of projects]: http://springsource.org/projects [family of projects]: http://spring.io/projects
[SpringSource organization]: https://github.com/SpringSource [Spring organization]: https://github.com/spring-projects
[downloading Spring artifacts]: https://github.com/SpringSource/spring-framework/wiki/Downloading-Spring-artifacts [downloading Spring artifacts]: https://github.com/spring-projects/spring-framework/wiki/Downloading-Spring-artifacts
[building a distribution with dependencies]: https://github.com/SpringSource/spring-framework/wiki/Building-a-distribution-with-dependencies [building a distribution with dependencies]: https://github.com/spring-projects/spring-framework/wiki/Building-a-distribution-with-dependencies
[Javadoc]: http://static.springsource.org/spring-framework/docs/current/javadoc-api [Javadoc]: http://docs.spring.io/spring-framework/docs/current/javadoc-api/
[reference docs]: http://static.springsource.org/spring-framework/docs/current/spring-framework-reference [reference docs]: http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/
[Spring forums]: http://forum.springsource.org [Spring forums]: http://forum.spring.io/
[spring tag]: http://stackoverflow.com/questions/tagged/spring [spring tag]: http://stackoverflow.com/questions/tagged/spring
[spring-mvc tag]: http://stackoverflow.com/questions/tagged/spring-mvc [spring-mvc tag]: http://stackoverflow.com/questions/tagged/spring-mvc
[Stack Overflow]: http://stackoverflow.com/faq [Stack Overflow]: http://stackoverflow.com/faq
[Commercial support]: http://springsource.com/support/springsupport [Commercial support]: http://spring.io/services
[Spring Framework JIRA]: http://jira.springsource.org/browse/SPR [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 [the lifecycle of an issue]: https://github.com/spring-projects/spring-framework/wiki/The-Lifecycle-of-an-Issue
[spring-framework-issues]: https://github.com/SpringSource/spring-framework-issues#readme [spring-framework-issues]: https://github.com/spring-projects/spring-framework-issues#readme
[readme]: https://github.com/SpringSource/spring-framework-issues#readme [readme]: https://github.com/spring-projects/spring-framework-issues#readme
[Gradle]: http://gradle.org [Gradle]: http://gradle.org
[`./gradlew`]: http://vimeo.com/34436402 [`./gradlew`]: http://vimeo.com/34436402
[Git]: http://help.github.com/set-up-git-redirect [Git]: http://help.github.com/set-up-git-redirect
[JDK8 build]: http://jdk8.java.net/download.html [JDK8 build]: http://jdk8.java.net/download.html
[Gradle build and release FAQ]: https://github.com/SpringSource/spring-framework/wiki/Gradle-build-and-release-FAQ [Gradle build and release FAQ]: https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ
[Pull requests]: http://help.github.com/send-pull-requests [Pull requests]: http://help.github.com/send-pull-requests
[contributor guidelines]: https://github.com/SpringSource/spring-framework/blob/master/CONTRIBUTING.md [contributor guidelines]: https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.md
[@springframework]: http://twitter.com/springframework [@springframework]: http://twitter.com/springframework
[team members]: http://spring.io/team [team members]: https://twitter.com/springframework/team/members
[team blog]: http://blog.springsource.org [The Spring Blog]: http://spring.io/blog/
[news feed]: http://www.springsource.org/news-events [news feed]: http://spring.io/blog/category/news
[Apache License]: http://www.apache.org/licenses/LICENSE-2.0 [Apache License]: http://www.apache.org/licenses/LICENSE-2.0