documentation/getting_started.pod
changeset 8 eb5f524dc31d
parent 0 7f656887cf89
child 9 257450419d10
equal deleted inserted replaced
6:96d581d2147d 8:eb5f524dc31d
    12 #
    12 #
    13 
    13 
    14 
    14 
    15 __END__
    15 __END__
    16 
    16 
       
    17 =head1 Getting started with FShell
       
    18 
    17 =head1 Retreiving the FShell Source Code
    19 =head1 Retreiving the FShell Source Code
    18 
    20 
    19 I<Todo - add instructions for accessing the Mercurial repository.>
    21 I<Todo - add instructions for accessing the Mercurial repository.>
    20 
    22 
    21 =head1 Building FShell
    23 =head1 Building FShell
    30 
    32 
    31 =item * Nokia Symbian Timebox 9.2
    33 =item * Nokia Symbian Timebox 9.2
    32 
    34 
    33 =back
    35 =back
    34 
    36 
    35 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. Open a command prompt and C<cd> to this directory.
    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.
    36 
    38 
    37 You also need to identify the type of binaries you want to build. Common ones are:
    39 You also need to identify the type of binaries you want to build. Common ones are:
    38 
    40 
    39 =over 5
    41 =over 5
    40 
    42 
    46 
    48 
    47 Used for running fshell on either physical or simulated ARM hardware. Requires an installation of ARM's RVCT compiler. Version 2.2 is commonly used on current Symbian based handsets.
    49 Used for running fshell on either physical or simulated ARM hardware. Requires an installation of ARM's RVCT compiler. Version 2.2 is commonly used on current Symbian based handsets.
    48 
    50 
    49 =item * C<gcce>
    51 =item * C<gcce>
    50 
    52 
    51 Used for running fshell on either physical or simulated ARM hardware. Requires an installation of the GCC-E. I<Todo - does the SF provide builds of GCC-E?>
    53 Used for running fshell on either physical or simulated ARM hardware. Requires an installation of the GCC crosscompiler (for arm-none-symbianelf) - see here for more information: http://developer.symbian.org/wiki/index.php/The_GCCE_toolchain_initiative
    52 
    54 
    53 =back
    55 =back
    54 
    56 
    55 Lastly, you need to identify the build variant you plan to use, either debug (C<udeb>) or release (C<urel>). Commonly, C<udeb> is used on the emulator whereas C<urel> is used on target hardward. For the purposes of this introduction we will assume that you will be building C<winscw udeb> and C<armv5 urel>.
    57 Lastly, you need to identify the build variant you plan to use, either debug (C<udeb>) or release (C<urel>). Commonly, C<udeb> is used on the emulator whereas C<urel> is used on target hardware. For the purposes of this introduction we will assume that you will be building C<winscw udeb> and C<armv5 urel>.
    56 
    58 
    57 =head2 SBSv1 (aka abld)
    59 =head2 SBSv1 (aka abld)
    58 
    60 
    59   M:\fshell\build\s60\3>bldmake bldfiles
    61   M:\fshell\build\s60\3>bldmake bldfiles
    60   M:\fshell\build\s60\3>abld build winscw udeb
    62   M:\fshell\build\s60\3>abld build winscw udeb
    61   M:\fshell\build\s60\3>abld build armv5 urel
    63   M:\fshell\build\s60\3>abld build armv5 urel
    62 
    64 
    63 =head2 SBSv2 (aka Raptor)
    65 =head2 SBSv2 (aka Raptor)
    64 
    66 
    65   M:\fshell\build\sf\2>sbs -c armv5_urel -c winscw_udeb
    67   M:\fshell\build\sf\2>sbs -c armv5_urel
       
    68   M:\fshell\build\sf\2>sbs -c winscw_udeb
       
    69 
       
    70 I<Note:> There are currently some concurrency issues in the build process that mean we don't recommend building multiple platforms in a single invocation of sbs. Ie do the above rather than C<sbs -c armv5_urel -c winscw_udeb>. We'll fix this as soon as we can!
    66 
    71 
    67 =head1 Installation
    72 =head1 Installation
    68 
    73 
    69 Having performed a build, you should have a full set of binaries in your F<\epoc32> tree. If you want to run fshell on the emulator, no further action is necessary. If you want to run fshell on the simulator or target hardware, then the fshell binaries need to be either added to a ROM image or installed at runtime.
    74 Having performed a build, you should have a full set of binaries in your F<\epoc32> tree. If you want to run fshell on the emulator, no further action is necessary. If you want to run fshell on the simulator or target hardware, then the fshell binaries need to be either added to a ROM image or installed at runtime.
    70 
    75