updates
[silc.git] / 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 itself for Symbian OS, or for
6 Symbian OS emulator.  The building environment expects Carbide.c++ and
7 WINCW 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 Installing Build Environment
13 ============================
14
15 If you do not have a working Carbide.c++ and Symbian OS SDK environment 
16 installed in your MS Windows system it needs to be done first.
17
18 1) Download the freely available Carbide.c++ Express from Nokia at 
19    http://forum.nokia.com.  The exact hyprelink location changes often, so 
20    it is not referenced here.  It is usually under "Tools and SDKs" link.
21
22 2) After installation a web browser is opened automatically by the 
23    Carbide.c++ installer.  Follow its instructions by installing the Perl, 
24    CTags and the SDK.  Perl and the SDK are required, but CTags is 
25    optional and if necessary can be omitted.
26
27 3) The SILC Toolkit is generic C and C++ code and should work with any
28    SDK.  If you don't have SDK already installed, install the latest 
29    version you can find.  The links to SDKs are found in the Carbide.c++ 
30    instructions after installation.  If you already have SDK in your 
31    system, you should use that.
32
33 4) After installation the environment should be ready for SILC Toolkit 
34    building.
35
36
37 Building with Carbide.c++
38 =========================
39
40 After starting the Carbide.c++, you should import one of the SILC Toolkit 
41 projects under symbian/ directory in the SILC Toolkit package.  Four 
42 projects exist:
43
44         libsilc/                - SILC Core DLL
45         libsilcclient/          - SILC Client DLL
46         libsilc_static/         - SILC Core static library
47         libsilcclient_static/   - SILC Client static library
48
49 After loading the project, the first thing to do is to add a path variable 
50 to define where the SILC Toolkit sources are located.  Go to Window -> 
51 Preferences.  Then, go to General -> Workspace -> Linked Resources.  Add 
52 a new SILCROOT path variable.  It should point to the drive and directory 
53 where the extracted SILC Toolkit sources are located.  For example, if you 
54 extracted the SILC Toolkit package into C:\temp\silc-toolkit-1.1.5 the 
55 SILCROOT should point to C:\temp.  This needs to be done only once.
56
57 After that, the building is ready to begin.  Choose the target you want 
58 (emulator or device, debug or release version) and start building.