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

Reformat and add links to README 

The readme is heavy on links and hard to read in source form when using
typical inline Markdown links. The following changes have been made to
increase readability.

 - Wrap lines at 80 characters
 - Use 'implicit link name' shortcut syntax as described at [1]
 - Add link to 'spring-mvc' Stack Overflow tag as well
 - Add link to new 'lifecycle of an issue' wiki doc

[1]: http://daringfireball.net/projects/markdown/syntax
This commit is contained in:
Chris Beams 2012-06-19 17:16:26 +02:00
parent e5bbec7e2b
commit 9fc05a80d0
1 changed files with 64 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
README.md
View File

@ -1,45 +1,42 @@
## Spring Framework ## Spring Framework
The Spring Framework provides a comprehensive programming and configuration model for modern The Spring Framework provides a comprehensive programming and configuration
Java-based enterprise applications - on any kind of deployment platform. A key element of Spring is model for modern Java-based enterprise applications - on any kind of deployment
infrastructural support at the application level: Spring focuses on the "plumbing" of enterprise platform. A key element of Spring is infrastructural support at the application
applications so that teams can focus on application-level business logic, without unnecessary ties level: Spring focuses on the "plumbing" of enterprise applications so that teams
to specific deployment environments. can focus on application-level business logic, without unnecessary ties to
specific deployment environments.
The framework also serves as the foundation for The framework also serves as the foundation for [Spring Integration][], [Spring
[Spring Integration](https://github.com/SpringSource/spring-integration), Batch][] and the rest of the Spring [family of projects][]. Browse the
[Spring Batch](https://github.com/SpringSource/spring-batch) and the rest of the Spring repositories under the [SpringSource organization][] on GitHub for a full list.
[family of projects](http://springsource.org/projects). Browse the repositories under the
[SpringSource organization](https://github.com/SpringSource) on GitHub for a full list.
[.NET](https://github.com/SpringSource/spring-net) and [.NET][] and [Python][] variants are available as well.
[Python](https://github.com/SpringSource/spring-python) variants are available as well.
## Downloading artifacts ## Downloading artifacts
See [downloading Spring artifacts](https://github.com/SpringSource/spring-framework/wiki/Downloading-Spring-artifacts) See [downloading Spring artifacts][] for Maven repository information. Unable to
for Maven repository information. Unable to use Maven or other transitive dependency management tools? use Maven or other transitive dependency management tools? See [building a
See [building a distribution with dependencies](https://github.com/SpringSource/spring-framework/wiki/Building-a-distribution-with-dependencies). distribution with dependencies][].
## Documentation ## Documentation
See the current [Javadoc](http://static.springsource.org/spring-framework/docs/current/api) See the current [Javadoc][] and [reference docs][].
and [Reference docs](http://static.springsource.org/spring-framework/docs/current/reference).
## Getting support ## Getting support
Check out the [Spring forums](http://forum.springsource.org) and the Check out the [Spring forums][] and the [spring][spring tag] and
[Spring tag](http://stackoverflow.com/questions/tagged/spring) on StackOverflow. [spring-mvc][spring-mvc tag] tags on [Stack Overflow][]. [Commercial support][]
[Commercial support](http://springsource.com/support/springsupport) is available too. is available too.
## Issue Tracking ## Issue Tracking
Spring's JIRA issue tracker can be found [here](http://jira.springsource.org/browse/SPR). Think Report issues via the [Spring Framework JIRA]. Understand our issue management
you've found a bug? Please consider submitting a reproduction project via the process by reading about [the lifecycle of an issue][]. Think you've found a
[spring-framework-issues](https://github.com/SpringSource/spring-framework-issues) repository. The bug? Please consider submitting a reproduction project via the
[readme](https://github.com/SpringSource/spring-framework-issues#readme) provides simple [spring-framework-issues][] GitHub repository. The [readme][] there provides
step-by-step instructions. <a name="building_from_source"/> simple step-by-step instructions.
## Building from source ## Building from source
The Spring Framework uses a [Gradle](http://gradle.org)-based build system. In the instructions The Spring Framework uses a [Gradle][]-based build system. In the instructions
below, [`./gradlew`](http://vimeo.com/34436402) is invoked from the root of the source tree and below, [`./gradlew`][] is invoked from the root of the source tree and serves as
serves as a cross-platform, self-contained bootstrap mechanism for the build. The only a cross-platform, self-contained bootstrap mechanism for the build. The only
prerequisites are [git](http://help.github.com/set-up-git-redirect) and JDK 1.6+. prerequisites are [Git][] and JDK 1.6+.
### check out sources ### check out sources
`git clone git://github.com/SpringSource/spring-framework.git` `git clone git://github.com/SpringSource/spring-framework.git`
@ -53,19 +50,47 @@ prerequisites are [git](http://help.github.com/set-up-git-redirect) and JDK 1.6+
### 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.
... and discover more commands with `./gradlew tasks`. See also the ... and discover more commands with `./gradlew tasks`. See also the [Gradle
[Gradle build and release FAQ](https://github.com/SpringSource/spring-framework/wiki/Gradle-build-and-release-FAQ). build and release FAQ][].
## Contributing ## Contributing
[Pull requests](http://help.github.com/send-pull-requests) are welcome; see the [Pull requests][] are welcome; see the [contributor guidelines][].
[contributor guidelines](https://github.com/SpringSource/spring-framework/wiki/Contributor-guidelines).
## Staying in touch ## Staying in touch
Follow [@springframework](http://twitter.com/springframework) and its Follow [@springframework][] and its [team members][] on Twitter. In-depth
[team members](http://twitter.com/springframework/team/members) on Twitter. In-depth articles can be articles can be found at the SpringSource [team blog][], and releases are
found at the SpringSource [team blog](http://blog.springsource.org), and releases are announced via announced via our [news feed][].
our [news feed](http://www.springsource.org/news-events).
## License ## License
The Spring Framework is released under version 2.0 of the The Spring Framework is released under version 2.0 of the [Apache License][].
[Apache License](http://www.apache.org/licenses/LICENSE-2.0).
[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
[.NET]: https://github.com/SpringSource/spring-net
[Python]: https://github.com/SpringSource/spring-python
[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
[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
[contributor guidelines]: https://github.com/SpringSource/spring-framework/wiki/Contributor-guidelines
[@springframework]: http://twitter.com/springframework
[team members]: http://twitter.com/springframework/team/members
[team blog]: http://blog.springsource.org
[news feed]: http://www.springsource.org/news-events
[Apache License]: http://www.apache.org/licenses/LICENSE-2.0