Polish README
This commit is contained in:
parent
b1068fe71e
commit
4e384a636f
52
README.md
52
README.md
|
@ -1,37 +1,18 @@
|
||||||
## Spring Framework
|
Please read the
|
||||||
The Spring Framework provides a comprehensive programming and configuration
|
https://docs.spring.io/spring/docs/current/spring-framework-reference/overview.html#spring-introduction[Overview]
|
||||||
model for modern Java-based enterprise applications -- on any kind of deployment
|
in the reference documentation for a quick introduction.
|
||||||
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.
|
|
||||||
|
|
||||||
The framework also serves as the foundation for [Spring Integration][], [Spring Batch][]
|
This project is governed by the [Spring Code of Conduct](CODE_OF_CONDUCT.adoc).
|
||||||
and the rest of the Spring [family of projects][]. Browse the repositories under
|
By participating you are expected to uphold this code.
|
||||||
the [Spring organization][] on GitHub for a full list.
|
Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
|
||||||
|
|
||||||
## Code of Conduct
|
For Maven repository information see [downloading Spring artifacts][]. Unable to
|
||||||
This project adheres to the Contributor Covenant [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.
|
|
||||||
|
|
||||||
## Downloading Artifacts
|
|
||||||
See [downloading Spring artifacts][] 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 distribution with dependencies][].
|
See [building a distribution with dependencies][].
|
||||||
|
|
||||||
## Documentation
|
For documentation see the current [reference docs][], [Javadoc][], Github Wiki pages.
|
||||||
See the current [Javadoc][] and [reference docs][].
|
|
||||||
|
|
||||||
## Getting Support
|
For contributing see the [contributor guidelines][] for details.
|
||||||
Check out the [spring][spring tags] tags on [Stack Overflow][]. [Commercial support][]
|
|
||||||
is available too.
|
|
||||||
|
|
||||||
## Issue Tracking
|
|
||||||
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.
|
|
||||||
|
|
||||||
## 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
|
||||||
|
@ -61,9 +42,6 @@ Run `./import-into-eclipse.sh` or read `import-into-idea.md` as appropriate.
|
||||||
... and discover more commands with `./gradlew tasks`. See also the [Gradle
|
... and discover more commands with `./gradlew tasks`. See also the [Gradle
|
||||||
build and release FAQ][].
|
build and release FAQ][].
|
||||||
|
|
||||||
## Contributing
|
|
||||||
[Pull requests][] are welcome; see the [contributor guidelines][] for details.
|
|
||||||
|
|
||||||
## Staying in Touch
|
## Staying in Touch
|
||||||
Follow [@SpringCentral][] as well as [@SpringFramework][] and its [team members][]
|
Follow [@SpringCentral][] as well as [@SpringFramework][] and its [team members][]
|
||||||
on Twitter. In-depth articles can be found at [The Spring Blog][], and releases
|
on Twitter. In-depth articles can be found at [The Spring Blog][], and releases
|
||||||
|
@ -72,28 +50,18 @@ are announced via 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/spring-projects/spring-integration
|
|
||||||
[Spring Batch]: https://github.com/spring-projects/spring-batch
|
|
||||||
[family of projects]: http://spring.io/projects
|
|
||||||
[Spring organization]: https://github.com/spring-projects
|
|
||||||
[downloading Spring artifacts]: https://github.com/spring-projects/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/spring-projects/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://docs.spring.io/spring-framework/docs/current/javadoc-api/
|
[Javadoc]: http://docs.spring.io/spring-framework/docs/current/javadoc-api/
|
||||||
[reference docs]: http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/
|
[reference docs]: http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/
|
||||||
[spring tags]: http://spring.io/questions
|
|
||||||
[Stack Overflow]: http://stackoverflow.com/faq
|
|
||||||
[Commercial support]: http://spring.io/services
|
|
||||||
[Spring Framework JIRA]: https://jira.spring.io/browse/SPR
|
[Spring Framework JIRA]: https://jira.spring.io/browse/SPR
|
||||||
[the lifecycle of an issue]: https://github.com/spring-projects/spring-framework/wiki/The-Lifecycle-of-an-Issue
|
|
||||||
[spring-framework-issues]: https://github.com/spring-projects/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://www.oracle.com/technetwork/java/javase/downloads
|
[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
|
[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/
|
[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.md
|
[contributor guidelines]: https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.adoc
|
||||||
[@SpringFramework]: https://twitter.com/springframework
|
[@SpringFramework]: https://twitter.com/springframework
|
||||||
[@SpringCentral]: https://twitter.com/springcentral
|
[@SpringCentral]: https://twitter.com/springcentral
|
||||||
[team members]: https://twitter.com/springframework/lists/team/members
|
[team members]: https://twitter.com/springframework/lists/team/members
|
||||||
|
|
Loading…
Reference in New Issue