Permalink
Browse files

Added clone and build instructions to README

  • Loading branch information...
1 parent 2307aa9 commit 54c58227cd05892460bb8c39266c5ef2ce0ff980 @magott committed Feb 14, 2012
Showing with 36 additions and 1 deletion.
  1. +36 −1 README
View
37 README
@@ -1 +1,36 @@
-A Spring Social adapter for Yammer (www.yammer.com). A work in progress, which means some APIs might change. Do not expect any major changes beyond some datatypes (ie long > Long).
+-------------------------------------------------------------------------------
+To get the code and build from source, do the following:
+
+git clone --recursive git://github.com/magott/spring-social-yammer.git
+cd spring-social
+./gradlew build
+
+Note: the --recursive switch above is important, as spring-social uses
+git submodules, which must themselves be cloned and initialized. If --recursive
+is omitted, doing so becomes a multi-step process of:
+
+git clone git://github.com/magott/spring-social-yammer.git
+git submodule init
+git submodule update
+
+-------------------------------------------------------------------------------
+To generate Eclipse metadata (.classpath and .project files), do the following:
+
+./gradlew eclipse
+
+Once complete, you may then import the projects into Eclipse:
+File -> Import -> Existing projects into workspace
+
+-------------------------------------------------------------------------------
+To generate IDEA metadata (.iml and .ipr files), do the following:
+
+./gradlew idea
+
+-------------------------------------------------------------------------------
+To build the JavaDoc, do the following from within the root directory:
+
+ ./gradlew :docs:api
+
+The result will be available in 'docs/build/api'.
+
+-------------------------------------------------------------------------------

0 comments on commit 54c5822

Please sign in to comment.