Mac OS X >= 10.7 support
[runtime.git] / README.SYMBIAN
1 Compiling SILC Runtime Toolkit for Symbian OS
2 =============================================
3
4 The SRT works on Symbian OS.  This document is intended for those that
5 want to compile the SRT by themselves for Symbian OS, or for Symbian OS
6 emulator.  The building environment expects Carbide.c++ and WINSCW compiler
7 for emulator target and GCCE (variant of GCC) for device target.  The SRT
8 has not been tested with other compilers or build systems.  The build
9 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 Runtime 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 SRT building.
41
42
43 Building with Carbide.c++
44 =========================
45
46 After starting the Carbide.c++ you will need to import the SRT project.
47 Go to File -> Import -> Symbian OS -> Symbian OS Bld.inf file, and go
48 to the extracted SRT source tree and find symbian\bld.inf file and import
49 it.  When Carbide.c++ asks for the Root Directory, select the root of the
50 extracted SRT source tree, if not already selected.
51
52 After importing the project it is immediately ready for building.  By
53 default, it will build the following libraries:
54
55         silc.dll                - SILC Core DLL
56         silcclient.dll          - SILC Client DLL
57         silc.lib                - SILC Core static library
58         silcclient.lib          - SILC Client static library
59
60 Before building select the target for which you want to build.  Possible
61 targets are Emulator or Phone with Debug or Release.
62
63
64 Using SILC Runtime in Your Project
65 ==================================
66
67 When linking with SRT libraries your application will need to also link
68 the following Symbian libraries:
69
70         estlib
71         euser
72         insock
73         esock
74
75 You will also need to include the \epoc32\include\libc into your system
76 include path in your project, if not already included.