From b351bc8bd94a58a41b9730aec6e7b8f228e18bd6 Mon Sep 17 00:00:00 2001 From: Fernando F D Bittencourt Date: Thu, 31 May 2018 19:35:53 -0300 Subject: [PATCH] Change the 'README' to the Github text pattern. Change the 'README' to the Github text pattern to match the other spring projects. --- README | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README b/README index 511b1c62..d9dfb974 100644 --- a/README +++ b/README @@ -1,28 +1,28 @@ -============================= Spring Social GitHub ============================ +== Spring Social GitHub To check out the project and build from source, do the following: - +---- git clone git://github.com/SpringSource/spring-social-github.git cd spring-social-github ./gradlew build - -------------------------------------------------------------------------------- +---- +== Generating Metadata +=== Eclipse To generate Eclipse metadata (.classpath and .project files), do the following: - +---- ./gradlew eclipse - +---- Once complete, you may then import the projects into Eclipse as usual: File -> Import -> Existing projects into workspace -------------------------------------------------------------------------------- +=== IDEA To generate IDEA metadata (.iml and .ipr files), do the following: - +---- ./gradlew idea - -------------------------------------------------------------------------------- +---- +== Building the JavaDoc To build the JavaDoc, do the following from within the root directory: - +---- ./gradlew :docs:api - +---- The result will be available in 'docs/build/api'. -===============================================================================