Orb/INSTALL.txt
changeset 0 42188c7ea2d9
child 1 82f11024044a
equal deleted inserted replaced
-1:000000000000 0:42188c7ea2d9
       
     1 License
       
     2 =======
       
     3 Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved.
       
     4 This component and the accompanying materials are made available under the terms of the License 
       
     5 "Eclipse Public License v1.0" which accompanies this distribution, 
       
     6 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 
       
     8 Welcome to Orb
       
     9 ==============
       
    10 Orb is a package containing a version of Doxygen that produces Dita XML and extentions to the Symbian Build System that invoke Doxygen on its build targets.
       
    11 
       
    12 Installation
       
    13 ============
       
    14 
       
    15     * Install a PDK or SDK for development on the Symbian Platform. (i.e Symbian Foundation SDK)
       
    16     * Install RVCT 2.2 onwards or another Symbian Build System compatible compiler.
       
    17     * Use the Symbian Build System (SBSv2) installer to install Symbian Build System or extract it to a directory and add it to your system path and set the environment variable SBS_HOME to this directory.
       
    18     * Orb requires Apache Ant to convert the Doxygen cxx output to dita reference and DITA dtds to verify the xml. 
       
    19       Install ant to SBS_HOME\ant.
       
    20     * Extract Orb to your Symbian Build System application directory (SBS_HOME)
       
    21 
       
    22 Running Orb
       
    23 ===========
       
    24 Please refer to README.txt for information on running Orb