svn commit: r1528027 - /sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext

[bd...@apache.org]

Author: bdelacretaz
Date: Tue Oct  1 10:04:10 2013
New Revision: 1528027

URL: http://svn.apache.org/r1528027
Log:
tl:dr build instructions added

Modified:
    sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext

Modified: sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext?rev=1528027&r1=1528026&r2=1528027&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext (original)
+++ sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext Tue Oct  1 10:04:10 2013
@@ -13,6 +13,20 @@ Note that you don't *have* to build Slin
 
 A full build of Sling takes 5-10 minutes on a recent computer once your local Maven repository is up to date. The first build may take much longer than that if you start with an empty local Maven repository, as Maven will then download its plugins and all the required dependencies.
 
+## tl:dr - Short form build + run instructions 
+If you already have the required svn (or Git, see below) client, JDK and Maven installed, here's the short form recipe:
+
+    $ svn co http://svn.apache.org/repos/asf/sling/trunk sling
+    $ cd sling
+    $ export MAVEN_OPTS= (see below)
+    $ mvn clean install (maybe with -DskipTests if you know what you're doing)
+    $ cd launchpad/builder
+    $ rm -rf ../builder/sling (if needed, to cleanup previous state)
+    $ export DBG="-Xmx384M -agentlib:jdwp..." (see below) 
+    $ java $DBG -jar target/org.apache.sling.launchpad... (see below)
+    
+And Sling should be running at http://localhost:8080 with remote debugging active as per the $DBG variable.      
+
 ## Prerequisites
 
 Before you begin, you need to have the following tools installed on your system:
@@ -30,7 +44,6 @@ If you want to set up Eclipse (not requi
 
 The full build process requires quite a lot of resources, so you may run into limits. The following hints should show you what to setup before building Sling.
 
-
 ### Java Heap Space
 
 * *Problem* \- Build aborts with reports of `java.lang.OutOfMemoryError: Java heap space`. Alternatively the build may randomly fail during the integration tests.
@@ -67,16 +80,23 @@ This problem is caused by insufficient s
 
 See [MavenTipsAndTricks]({{ refs.maventipsandtricks.path }}).
 
-
 ## Getting the Sling Source
 
+### From the Apache Sling Subversion repository
 
-### With SVN
+0. Install an svn client if needed.
 
-1. Checkout Sling from the Repository.
+1. Checkout Sling from the Subversion repository
 
     $ svn checkout http://svn.apache.org/repos/asf/sling/trunk sling
 
+### From the Sling GitHub mirror
+
+0. Install a Git client if needed
+
+1. Checkout Sling from the GitHub mirror
+
+    $ git clone https://github.com/apache/sling.git
 
 ### With Eclipse Subversive or Subclipse
 First note how simple the above SVN instructions are...but if you *really* want to do this, read on.