svn commit: r1231983 - in /incubator/any23/trunk/src/site: apt/build-src.apt site.xml

[si...@apache.org]

Author: simonetripodi
Date: Mon Jan 16 12:54:35 2012
New Revision: 1231983

URL: http://svn.apache.org/viewvc?rev=1231983&view=rev
Log:
added a page that describes how to build Any23 from sources (copied from the Installation page, that will be modified according to the current binary distributions)

Added:
    incubator/any23/trunk/src/site/apt/build-src.apt   (with props)
Modified:
    incubator/any23/trunk/src/site/site.xml

Added: incubator/any23/trunk/src/site/apt/build-src.apt
URL: http://svn.apache.org/viewvc/incubator/any23/trunk/src/site/apt/build-src.apt?rev=1231983&view=auto
==============================================================================
--- incubator/any23/trunk/src/site/apt/build-src.apt (added)
+++ incubator/any23/trunk/src/site/apt/build-src.apt Mon Jan 16 12:54:35 2012
@@ -0,0 +1,76 @@
+                                    ------
+                                    Apache Any23 - Build from sources
+                                    ------
+                              The Apache Software Foundation
+                                    ------
+                                     2011-2012
+
+~~  Licensed to the Apache Software Foundation (ASF) under one or more
+~~  contributor license agreements.  See the NOTICE file distributed with
+~~  this work for additional information regarding copyright ownership.
+~~  The ASF licenses this file to You under the Apache License, Version 2.0
+~~  (the "License"); you may not use this file except in compliance with
+~~  the License.  You may obtain a copy of the License at
+~~
+~~     http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~  Unless required by applicable law or agreed to in writing, software
+~~  distributed under the License is distributed on an "AS IS" BASIS,
+~~  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~  See the License for the specific language governing permissions and
+~~  limitations under the License.
+
+Build Apache Any23 from sources
+
+    This page describes how to build <<Apache Any23>>.
+ 
+* Access a Snapshot Version
+
+    For the latest snapshot please checkout the code from the SVN code repository and build the library.
+    Checkout the code from SVN:
+
++---------------------------------------------------------------------------
+$ svn checkout http://svn.apache.org/repos/asf/incubator/any23/trunk apache-any23-trunk-readonly
++---------------------------------------------------------------------------
+
+* Build <<Apache Any23>>
+
+    The following instructions describe how to build the library with {{{http://maven.apache.org/}Maven 2.x.y+}}.
+    For specific information about Maven see: {{{http://maven.apache.org/}}}
+    Go to the trunk folder:
+
++-----------
+$ cd trunk/
++-----------
+
+    and execute the following command:
+
++-----------
+trunk$ mvn clean install
++-----------
+
+    This will install the <<Apache Any23>> artifact and its dependencies in your local M2 repository.
+
+* Generate Documentation
+
+    To generate the project site locally execute the following command from the trunk dir:
+
++---------------------------------------------------------------------------
+trunk$ MAVEN_OPTS='-Xmx1024m' mvn clean site
++---------------------------------------------------------------------------
+
+    You can speed up the site generation process specifying the offline option ( -o ),
+    but it works only if all the involved plugin dependencies has been already downloaded
+    in the local M2 repository:
+
++---------------------------------------------------------------------------
+trunk$ MAVEN_OPTS='-Xmx1024m' mvn -o clean site
++---------------------------------------------------------------------------
+
+    If you're interested in generating the Javadoc enriched with navigable UML graphs, you can activate
+    the umlgraphdoc profile. This profile relies on {{{http://www.graphviz.org/}Graphviz}} that must be
+    installed in your system.
+
++---------------------------------------------------------------------------
+trunk$ MAVEN_OPTS='-Xmx256m' mvn -P umlgraphdoc clean site
++---------------------------------------------------------------------------

Propchange: incubator/any23/trunk/src/site/apt/build-src.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/any23/trunk/src/site/apt/build-src.apt
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/any23/trunk/src/site/apt/build-src.apt
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Modified: incubator/any23/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/any23/trunk/src/site/site.xml?rev=1231983&r1=1231982&r2=1231983&view=diff
==============================================================================
--- incubator/any23/trunk/src/site/site.xml (original)
+++ incubator/any23/trunk/src/site/site.xml Mon Jan 16 12:54:35 2012
@@ -75,6 +75,7 @@
       <item name="REST Service"      href="./service.html"/>
       <item name="Any23 Plugins"     href="./any23-plugins.html"/>
       <item name="Developers Guide"  href="./developers.html" collapse="true">
+        <item href="./build-src.html"                  name="Build from sources"/>
         <item href="./dev-data-extraction.html"        name="Data Extraction"/>
         <item href="./dev-data-conversion.html"        name="Data Conversion"/>
         <item href="./dev-validation-fix.html"         name="Validation and Fixing"/>