Browse Source

SEC-2871: readme.txt->README.adoc

shaehnel 10 years ago
parent
commit
b3d108fa44
2 changed files with 58 additions and 81 deletions
  1. 58 0
      README.adoc
  2. 0 81
      readme.txt

+ 58 - 0
README.adoc

@@ -0,0 +1,58 @@
+= Spring Security
+
+Spring Security provides security services for the http://docs.spring.io[Spring IO Platform]. Spring Security 3.1 requires Spring 3.0.3 as
+a minimum and also requires Java 5.
+
+For a detailed list of features and access to the latest release, please visit http://spring.io/projects[Spring projects].
+
+== Downloading Artifacts
+See https://github.com/spring-projects/spring-framework/wiki/Downloading-Spring-artifacts[downloading Spring artifacts] for Maven repository information.
+
+== Documentation
+Be sure to read the http://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference].
+Extensive JavaDoc for the Spring Security code is also available in the http://docs.spring.io/spring-security/site/docs/current/apidocs/[Spring Security API Documentation].
+
+== Quick Start
+We recommend you visit http://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference] and read the "Getting Started" page.
+
+== Building from Source
+Spring Security uses a http://gradle.org[Gradle]-based build system. 
+In the instructions below, http://vimeo.com/34436402[`./gradlew`] is invoked from the root of the source tree and serves as
+a cross-platform, self-contained bootstrap mechanism for the build.
+
+=== Prerequisites
+http://help.github.com/set-up-git-redirect[Git] and the http://www.oracle.com/technetwork/java/javase/downloads[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
+[indent=0]
+----
+git clone git@github.com:spring-projects/spring-security.git
+----
+
+=== Install all spring-\* jars into your local Maven cache
+[indent=0]
+----
+./gradlew install
+----
+
+=== Compile and test; build all jars, distribution zips, and docs
+[indent=0]
+----
+./gradlew build
+----
+
+Discover more commands with `./gradlew tasks`. 
+See also the https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ[Gradle build and release FAQ].
+
+== Getting Support
+Check out the http://stackoverflow.com/questions/tagged/spring-security[Spring Security tags on Stack Overflow]. 
+http://spring.io/services[Commercial support] is available too.
+
+== Contributing
+http://help.github.com/send-pull-requests[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/master/CONTRIBUTING.md[contributor guidelines] for details.
+
+== License
+Spring Boot is Open Source software released under the
+http://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].

+ 0 - 81
readme.txt

@@ -1,81 +0,0 @@
-===============================================================================
-                    SPRING SECURITY - README FILE
-===============================================================================
-
--------------------------------------------------------------------------------
-OVERVIEW
--------------------------------------------------------------------------------
-
-Spring Security provides security services for the Spring Framework
-(http://www.springframework.org). Spring Security 3.1 requires Spring 3.0.3 as
-a minimum and also requires Java 5.
-
-For a detailed list of features and access to the latest release, please visit
-http://www.springframework.org/projects/.
-
-Spring Security is released under an Apache 2.0 license. See the accompanying
-license.txt file.
-
--------------------------------------------------------------------------------
-BUILDING
--------------------------------------------------------------------------------
-
-Please read the "Building from Source" page at
-http://static.springframework.org/spring-security/site/.
-
--------------------------------------------------------------------------------
-DOCUMENTATION
--------------------------------------------------------------------------------
-
-Be sure to read the Reference Guide  (docs/reference/html/springsecurity.html).
-Extensive JavaDoc for the Spring Security code is also available (in docs/apidocs).
-Both can also be found on the website.
-
--------------------------------------------------------------------------------
-QUICK START
--------------------------------------------------------------------------------
-
-We recommend you visit http://static.springframework.org/spring-security/site and
-read the "Getting Started" page.
-
--------------------------------------------------------------------------------
-MAVEN REPOSITORY DOWNLOADS
--------------------------------------------------------------------------------
-
-Release jars for the project are available from the central maven repository
-
-http://repo1.maven.org/maven2/org/springframework/security/
-
-Note that milestone releases and snapshots are not uploaded to the central
-repository, but can be obtained from the Spring milestone repository, using the
-maven repository http://maven.springframework.org/snapshot/. You can't browse this
-URL directly, but there is a separate browser interface. Check the downloads page
-for more information
-http://static.springsource.org/spring-security/site/downloads.html
-
-
--------------------------------------------------------------------------------
-OBTAINING SUPPORT
--------------------------------------------------------------------------------
-
-There are two types of support available, commercial and community. For
-commercial support, please contact SpringSource. SpringSource employ the
-people who wrote Spring Security, and lead the development of the project:
-
-  http://www.springsource.com
-
-For peer help and assistance, please use the Spring Security forum
-located at the Spring Community's forum site:
-
-  http://forum.springframework.org
-
-Links to the forums, and other useful resources are
-available from the web site.
-
--------------------------------------------------------------------------------
-CONTRIBUTING
--------------------------------------------------------------------------------
-
-Contributions are welcome. Please refer to the Contributor Guidelines for details
-
-  https://github.com/SpringSource/spring-security/wiki/Contributor-Guidelines