README.SYMBIAN

   1 Compiling SILC Toolkit for Symbian OS
   2 =====================================
   3
   4 The SILC Toolkit works on Symbian OS.  This document is intended for those
   5 that want to compile the SILC Toolkit by themselves for Symbian OS, or for
   6 Symbian OS emulator.  The building environment expects Carbide.c++ and
   7 WINSCW compiler for emulator target and GCCE (variant of GCC) for device
   8 target.  The SILC Toolkit has not been tested with other compilers or
   9 build systems.  The build environment expects MS Windows.
  10
  11
  12 Requirements
  13 ============
  14
  15 - MS Windows
  16 - Carbide.c++ 1.2 or newer
  17
  18
  19 Installing Build Environment
  20 ============================
  21
  22 If you do not have a working Carbide.c++ and Symbian OS SDK environment
  23 installed in your MS Windows system it needs to be done first.
  24
  25 1) Download the freely available Carbide.c++ from Nokia at
  26    http://forum.nokia.com.  The exact hyperlink location changes often, so
  27    it is not referenced here.  It is usually under "Tools and SDKs" link.
  28
  29 2) After installation a web browser is opened automatically by the
  30    Carbide.c++ installer.  Follow its instructions by installing the Perl,
  31    CTags and the SDK.  Perl and the SDK are required, but CTags is
  32    optional and if necessary can be omitted.
  33
  34 3) The SILC Toolkit is generic C and C++ code and should work with any
  35    SDK.  If you don't have SDK already installed, install the latest
  36    version you can find.  The links to SDKs are found in the Carbide.c++
  37    instructions after installation.  If you already have SDK in your
  38    system, you should use that.
  39
  40 4) After installation the environment should be ready for SILC Toolkit
  41    building.
  42
  43
  44 Building with Carbide.c++
  45 =========================
  46
  47 After starting the Carbide.c++ you will need to import the SILC Toolkit
  48 project.  Go to File -> Import -> Symbian OS -> Symbian OS Bld.inf file,
  49 and go to the extracted SILC Toolkit source tree and find symbian\bld.inf
  50 file and import it.  When Carbide.c++ asks for the Root Directory, select
  51 the root of the extracted SILC Toolkit source tree, if not already
  52 selected.
  53
  54 After importing the project it is immediately ready for building.  By
  55 default, it will build the following libraries:
  56
  57         silc.dll                - SILC Core DLL
  58         silcclient.dll          - SILC Client DLL
  59         silc.lib                - SILC Core static library
  60         silcclient.lib          - SILC Client static library
  61
  62 Before building select the target for which you want to build.  Possible
  63 targets are Emulator or Phone with Debug or Release.
  64
  65
  66 Using SILC Toolkit in Your Project
  67 ==================================
  68
  69 When linking with SILC libraries your application will need to also link
  70 the following Symbian libraries:
  71
  72         estlib
  73         euser
  74         insock
  75         esock
  76
  77 You will also need to include the \epoc32\include\libc into your system
  78 include path in your project, if not already included.