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

103 lines
5.0 KiB
Markdown
Raw Normal View History

Add readme
2011-12-20 17:36:59 +08:00
## Spring Framework
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
2012-06-19 23:16:26 +08:00
The Spring Framework provides a comprehensive programming and configuration
Remove link to forums in README
2015-01-10 06:14:56 +08:00
model for modern Java-based enterprise applications -- on any kind of deployment
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
2012-06-19 23:16:26 +08:00
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.
Add readme
2011-12-20 17:36:59 +08:00
Remove link to forums in README
2015-01-10 06:14:56 +08:00
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 [Spring organization][] on GitHub for a full list.
Add readme
2011-12-20 17:36:59 +08:00
Add Code of Conduct
2016-02-02 04:37:35 +08:00
## Code of Conduct
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.
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
## Downloading Artifacts
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
2012-06-19 23:16:26 +08:00
See [downloading Spring artifacts][] for Maven repository information. Unable to
Remove link to forums in README
2015-01-10 06:14:56 +08:00
use Maven or other transitive dependency management tools?
See [building a distribution with dependencies][].
Add readme
2011-12-20 17:36:59 +08:00
## Documentation
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
2012-06-19 23:16:26 +08:00
See the current [Javadoc][] and [reference docs][].
Add readme
2011-12-20 17:36:59 +08:00
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
## Getting Support
Remove link to forums in README
2015-01-10 06:14:56 +08:00
Check out the [spring][spring tags] tags on [Stack Overflow][]. [Commercial support][]
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
2012-06-19 23:16:26 +08:00
is available too.
Add readme
2011-12-20 17:36:59 +08:00
## Issue Tracking
Remove link to forums in README
2015-01-10 06:14:56 +08:00
Report issues via the [Spring Framework JIRA][]. Understand our issue management
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
2012-06-19 23:16:26 +08:00
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.
Update README and add IDE import helper scripts - Update building from source section with Gradle instructions - Add import-into-eclipse.sh interactive helper script - Add import-into-idea.md with steps and known issues Note that use of STS Gradle tooling was attempted, but several issues remain before it can handle the spring-framework build. In the meantime the instructions laid out in import-into-eclipse provide an error-free import.
2012-01-20 21:53:56 +08:00
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
## Building from Source
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
2012-06-19 23:16:26 +08:00
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
Update README.md - Remove references to python and .net variants - Update prereqs for building from source to JDK 1.8
2013-05-08 15:27:13 +08:00
a cross-platform, self-contained bootstrap mechanism for the build.
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
### Prerequisites
Update README.md - Remove references to python and .net variants - Update prereqs for building from source to JDK 1.8
2013-05-08 15:27:13 +08:00
Update link to JDK 8 download
2014-09-01 20:55:17 +08:00
[Git][] and [JDK 8 update 20 or later][JDK8 build]
Revise note on avoiding "lambda" JDK
2013-05-22 16:06:13 +08:00
Be sure that your `JAVA_HOME` environment variable points to the `jdk1.8.0` folder
extracted from the JDK download.
Update README and add IDE import helper scripts - Update building from source section with Gradle instructions - Add import-into-eclipse.sh interactive helper script - Add import-into-idea.md with steps and known issues Note that use of STS Gradle tooling was attempted, but several issues remain before it can handle the spring-framework build. In the meantime the instructions laid out in import-into-eclipse provide an error-free import.
2012-01-20 21:53:56 +08:00
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
### Check out sources
`git clone git@github.com:spring-projects/spring-framework.git`
Update README and add IDE import helper scripts - Update building from source section with Gradle instructions - Add import-into-eclipse.sh interactive helper script - Add import-into-idea.md with steps and known issues Note that use of STS Gradle tooling was attempted, but several issues remain before it can handle the spring-framework build. In the meantime the instructions laid out in import-into-eclipse provide an error-free import.
2012-01-20 21:53:56 +08:00
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
### Import sources into your IDE
Clarify instructions for building from source Re-order subsections to make it clear that running a full `./gradlew build` is not necessary just to import projects into your IDE or to build and install jars to your .m2 cache.
2013-05-22 15:48:14 +08:00
Run `./import-into-eclipse.sh` or read `import-into-idea.md` as appropriate.
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
> **Note:** Per the prerequisites above, ensure that you have JDK 8 configured properly in your IDE.
Update README and add IDE import helper scripts - Update building from source section with Gradle instructions - Add import-into-eclipse.sh interactive helper script - Add import-into-idea.md with steps and known issues Note that use of STS Gradle tooling was attempted, but several issues remain before it can handle the spring-framework build. In the meantime the instructions laid out in import-into-eclipse provide an error-free import.
2012-01-20 21:53:56 +08:00
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
### Install all spring-\* jars into your local Maven cache
Update README and add IDE import helper scripts - Update building from source section with Gradle instructions - Add import-into-eclipse.sh interactive helper script - Add import-into-idea.md with steps and known issues Note that use of STS Gradle tooling was attempted, but several issues remain before it can handle the spring-framework build. In the meantime the instructions laid out in import-into-eclipse provide an error-free import.
2012-01-20 21:53:56 +08:00
`./gradlew install`
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
### Compile and test; build all jars, distribution zips, and docs
Clarify instructions for building from source Re-order subsections to make it clear that running a full `./gradlew build` is not necessary just to import projects into your IDE or to build and install jars to your .m2 cache.
2013-05-22 15:48:14 +08:00
`./gradlew build`
Update README and add IDE import helper scripts - Update building from source section with Gradle instructions - Add import-into-eclipse.sh interactive helper script - Add import-into-idea.md with steps and known issues Note that use of STS Gradle tooling was attempted, but several issues remain before it can handle the spring-framework build. In the meantime the instructions laid out in import-into-eclipse provide an error-free import.
2012-01-20 21:53:56 +08:00
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
2012-06-19 23:16:26 +08:00
... and discover more commands with `./gradlew tasks`. See also the [Gradle
build and release FAQ][].
Add readme
2011-12-20 17:36:59 +08:00
## Contributing
Work around apparent bug in README markdown parsing The exact text above the "Staying in touch" section caused "Staying in touch" to lose it's formatting as a second-level heading. Adding " for details" to the sentence above works around the problem.
2012-06-26 01:33:56 +08:00
[Pull requests][] are welcome; see the [contributor guidelines][] for details.
Add readme
2011-12-20 17:36:59 +08:00
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
## Staying in Touch
Link to @SpringCentral in README
2014-03-01 00:18:38 +08:00
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][].
Add readme
2011-12-20 17:36:59 +08:00
## License
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
2012-06-19 23:16:26 +08:00
The Spring Framework is released under version 2.0 of the [Apache License][].
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
[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
[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/
Remove link to forums in README
2015-01-10 06:14:56 +08:00
[spring tags]: http://spring.io/questions
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
2012-06-19 23:16:26 +08:00
[Stack Overflow]: http://stackoverflow.com/faq
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
[Commercial support]: http://spring.io/services
Update links to Spring JIRA server
2014-03-10 19:24:20 +08:00
[Spring Framework JIRA]: https://jira.spring.io/browse/SPR
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
[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
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
2012-06-19 23:16:26 +08:00
[Gradle]: http://gradle.org
[`./gradlew`]: http://vimeo.com/34436402
[Git]: http://help.github.com/set-up-git-redirect
Update link to JDK 8 download
2014-09-01 20:55:17 +08:00
[JDK8 build]: http://www.oracle.com/technetwork/java/javase/downloads
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
[Gradle build and release FAQ]: https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ
Update README.md
2016-09-07 14:25:08 +08:00
[Pull requests]: https://help.github.com/categories/collaborating-on-projects-using-issues-and-pull-requests/
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
[contributor guidelines]: https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.md
Link to @SpringCentral in README
2014-03-01 00:18:38 +08:00
[@SpringFramework]: https://twitter.com/springframework
[@SpringCentral]: https://twitter.com/springcentral
Update link to @SpringFramework team members
2014-09-01 20:58:06 +08:00
[team members]: https://twitter.com/springframework/lists/team/members
Polish formatting and update links in README
2014-02-28 23:05:49 +08:00
[The Spring Blog]: http://spring.io/blog/
[news feed]: http://spring.io/blog/category/news
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
2012-06-19 23:16:26 +08:00
[Apache License]: http://www.apache.org/licenses/LICENSE-2.0