/*
 * ============================================================================
 *  Name     : ReadMe
 *  Part of  : AOExample
 *  Created  : 10.8.2004 by Forum Nokia
 *  Description:
 *      This file describes the usage and the implementation notes about the
 *      active object application for Series 60 Developer Platform 2nd Edition.
 *  Version  : 1.0
 *  Copyright: Nokia Corporation
 * ============================================================================
 */

1. Overview

    The AOExample application demonstrates how to write and use own active 
    objects that utilize asynchronous services. The example consists of a UI 
    and an engine.
    
    The engine is an active object that fetches a document from the Web
    server. The UI is a really simple application that launches the engine
    and shows the progress of it. The engine is explained briefly in 
    the document included in this example package.

2. Compatibility

    The AOExample example application is compatible with Series 60 Developer 
    Platform 2.0. It has been tested to work with the Nokia 6600 device. 
    The UI has also been tested in the WINS emulator on Series 60 version 2.0
    but the emulator must be upgraded to support networking before testing 
    the engine side.

3. About Sources

    The sources conform the directory structures created by the "Series 60
    AppWizard v1.9":

    * Header Files are in the subdirectory "inc".
    * The Implementation files are in the subdirectory "src".
    
    There is also some testing code in the directory test. The directory
    can be ignored (there is only a small project that tests the URL
    parsing).

4. Building

    To build the application for the device, do as follows:

      1. Go to: "group".
      2. Run: "bldmake bldfiles".
      3. Run: "abld build thumb urel".
    
    To build the application for the WINS (emulator), do as follows:

      1. Go to: "group".
      2. Run: "bldmake bldfiles".
      3. Run: "abld build wins udeb".

5. Installation

    There is ready-made installation package (.SIS) file for
    Series 60 2.0 devices. The file can be installed to the device in 
    different ways including, for example, sending the file via infrared, 
    Bluetooth, or e-mail and then installing the file from the inbox. 
    Refer to the device抯 user抯 guide for more detailed information 
    on installing SIS files.
    
    There is also package file that can be used to recreate the
    SIS file. To create a SIS file:

      1. Build files for the device (see section 4 for details).
      2. Go to: "install".
      3. Run: "makesis AOExample.pkg".

    If the SDK has not been installed to the default directory, the
    paths in the package file have to be updated before running
    the makesis command.