GitHub-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Polish README.adoc

pull/12466/head
Do Nhu Vy 3 years ago committed by Marcus Da Coregio
parent
7bd6deccc3
commit
7497ff9023
1 changed files with 7 additions and 6 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 13
      README.adoc

13
README.adoc
Unescape View File

@ -30,7 +30,7 @@ In the instructions below, https://vimeo.com/34436402[`./gradlew`] is invoked fr
a cross-platform, self-contained bootstrap mechanism for the build. a cross-platform, self-contained bootstrap mechanism for the build.
=== Prerequisites === Prerequisites
https://help.github.com/set-up-git-redirect[Git] and the https://www.oracle.com/technetwork/java/javase/downloads[JDK17 build]. https://docs.github.com/en/get-started/quickstart/set-up-git[Git] and the https://www.oracle.com/java/technologies/downloads/#java17[JDK17 build].
Be sure that your `JAVA_HOME` environment variable points to the `jdk-17` folder extracted from the JDK download. Be sure that your `JAVA_HOME` environment variable points to the `jdk-17` folder extracted from the JDK download.
@ -40,13 +40,15 @@ Be sure that your `JAVA_HOME` environment variable points to the `jdk-17` folder
git clone git@github.com:spring-projects/spring-security.git git clone git@github.com:spring-projects/spring-security.git
---- ----
=== Install all spring-\* jars into your local Maven cache === Install all `spring-*.jar` into your local Maven repository.
[indent=0] [indent=0]
---- ----
./gradlew publishToMavenLocal ./gradlew publishToMavenLocal
---- ----
=== Compile and test; build all jars, distribution zips, and docs === Compile and test; build all JARs, distribution zips, and docs
[indent=0] [indent=0]
---- ----
./gradlew build ./gradlew build
@ -59,18 +61,17 @@ You can build the reference docs for this branch by running the following comman
./gradlew :spring-security-docs:antora ./gradlew :spring-security-docs:antora
---- ----
That command publishes the docs site to the _docs/build/site_ directory. That command publishes the docs site to the `_docs/build/site_` directory.
The https://github.com/spring-projects/spring-security/tree/docs-build[playbook branch] describes how to build the reference docs in detail. The https://github.com/spring-projects/spring-security/tree/docs-build[playbook branch] describes how to build the reference docs in detail.
Discover more commands with `./gradlew tasks`. 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 == Getting Support
Check out the https://stackoverflow.com/questions/tagged/spring-security[Spring Security tags on Stack Overflow]. Check out the https://stackoverflow.com/questions/tagged/spring-security[Spring Security tags on Stack Overflow].
https://spring.io/services[Commercial support] is available too. https://spring.io/services[Commercial support] is available too.
== Contributing == Contributing
https://help.github.com/articles/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/main/CONTRIBUTING.adoc[contributor guidelines] for details. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/main/CONTRIBUTING.adoc[contributor guidelines] for details.
== License == License
Spring Security is Open Source software released under the Spring Security is Open Source software released under the

Write Preview
Loading…
Cancel
Save