Orb/INSTALL.txt
author Jonathan Harrington <jonathan.harrington@nokia.com>
Wed, 11 Aug 2010 14:49:30 +0100
changeset 4 468f4c8d3d5b
parent 3 d8fccb2cd802
permissions -rw-r--r--
Orb version 0.2.0

License
=======
Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved.
This component and the accompanying materials are made available under the terms of the License 
"Eclipse Public License v1.0" which accompanies this distribution, 
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html".

Welcome to Orb
==============
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.

Full Orb documentation can be found on this wiki page: http://developer.symbian.org/wiki/index.php/Doctools/ORB

Installation
============

    * Install a PDK or SDK for development on the Symbian Platform. (i.e Symbian Foundation SDK from here: http://developer.symbian.org/main/tools_and_kits/index.php)
    * Install SBS (also known as Raptor).  
      - Orb version 0.1.9 and above supports all versions of SBS.
      Follow the instructions here: http://developer.symbian.org/wiki/index.php/Raptor_Build_System 
	  Make sure the installer sets the environment variable %SBS_HOME% to the SBS directory.
    * Extract Orb to your SBS application directory (%SBS_HOME%)

Running Orb
===========
Please refer to README.txt for information on running Orb or the Symbian Foundation WIKI page: http://developer.symbian.org/wiki/index.php/Doctools/ORB