documentation/getting_started.pod
changeset 42 a581f3c08c9a
parent 34 284c68d7a3ac
equal deleted inserted replaced
41:df16950e242e 42:a581f3c08c9a
    14 
    14 
    15 __END__
    15 __END__
    16 
    16 
    17 =head1 Getting started with FShell
    17 =head1 Getting started with FShell
    18 
    18 
       
    19 B< I<Note:> > This guide is in the process of being migrated to the wiki, here: http://developer.symbian.org/wiki/index.php/Fshell/Getting_Started
       
    20 
    19 =head1 Retreiving the FShell Source Code
    21 =head1 Retreiving the FShell Source Code
    20 
    22 
    21 I<Todo - add instructions for accessing the Mercurial repository.>
    23 fshell is hosted on the Symbian Foundation here: http://developer.symbian.org/main/source/packages/fshell
       
    24 
       
    25 To clone the MCL repository, do:
       
    26 
       
    27     hg clone https://developer.symbian.org/oss/MCL/sf/os/fshell/
    22 
    28 
    23 =head1 Building FShell
    29 =head1 Building FShell
    24 
    30 
    25 FShell is normally distributed in source code form, and so needs to be compiled before it can be used. The conventional Symbian build tools -- either SBSv1 (aka abld) or SBSv2 (aka Raptor) -- are used. Currently three Symbian OS based platforms are supported:
    31 FShell is normally distributed in source code form, and so needs to be compiled before it can be used. The conventional Symbian build tools -- either SBSv1 (aka abld) or SBSv2 (aka Raptor) -- are used. Currently three Symbian OS based platforms are supported:
    26 
    32 
    32 
    38 
    33 =item * Nokia Symbian Timebox 9.2
    39 =item * Nokia Symbian Timebox 9.2
    34 
    40 
    35 =back
    41 =back
    36 
    42 
    37 Each of these platforms have a separate directory with F<\fshell\build>. In some platforms there may be further separate sub-directories for specific variants of the platform. You need to identify a suitable directory (that contains a file named F<bld.inf>) from which to build from. For example to build for the Symbian^3 release you need to build from F<\fshell\build\sf\3>. Open a command prompt and C<cd> to this directory.
    43 Each of these platforms have a separate directory within F<\fshell\build>. For some platforms there may be further separate sub-directories for specific variants of the platform. You need to identify a suitable directory (that contains a file named F<bld.inf>) from which to build from. For example to build for the Symbian^3 release you need to build from F<\fshell\build\sf\3>. Open a command prompt and C<cd> to this directory.
    38 
    44 
    39 You also need to identify the type of binaries you want to build. Common ones are:
    45 You also need to identify the type of binaries you want to build. Common ones are:
    40 
    46 
    41 =over 5
    47 =over 5
    42 
    48