README.build

   1 This is very short description of FBReader build procedure.
   2
   3 1. Compiler.
   4
   5 All version of FBReader are configured for building on linux desktop
   6 computer. You need gcc compiler for building desktop version or cross
   7 gcc compiler for building package for another platform.
   8
   9 2. Libraries.
  10
  11 FBReader requires
  12   ** expat -- library for XML parsing. AFAIK, all popular destributions
  13      includes package with name like 'expat-dev' or 'libexpat-dev'.
  14      If you cannot find expat in your distribution, please visit
  15      http://expat.sourceforge.net
  16   ** libz and libbz2 -- libraries for zip and bzip2 (de)compression
  17   ** UI library -- this depends on your target platform. For desktop,
  18        Qt library, version 3.* or 4.*
  19      OR
  20        GTK+ library, version >= 2.4
  21      should be installed
  22   ** for win32 version, we use also libpng, libungif, libjpeg and libtiff
  23
  24 3. How to configure.
  25
  26 Before building FBReader, you should check (and may be edit) 2 files:
  27   ** makefiles/target.mk
  28      In this file you should define 3 variables:
  29        TARGET_ARCH -- target platform for building FBReader
  30        UI_TYPE -- UI library
  31        TARGET_STATUS -- "release", "debug" or "profile". "release" is
  32          reasonable choice for almost all users.
  33
  34      Possible pairs for TARGET_ARCH + UI_TYPE are:
  35         TARGET_ARCH = desktop               UI_TYPE = gtk
  36         TARGET_ARCH = desktop               UI_TYPE = qt
  37         TARGET_ARCH = desktop               UI_TYPE = qt4
  38         TARGET_ARCH = pepperpad3            UI_TYPE = gtk
  39         TARGET_ARCH = zaurus                UI_TYPE = qtopia-240x320
  40         TARGET_ARCH = zaurus                UI_TYPE = qtopia-640x480
  41         TARGET_ARCH = openzaurus            UI_TYPE = opie
  42         TARGET_ARCH = openzaurus            UI_TYPE = gpe
  43         TARGET_ARCH = pdaxrom               UI_TYPE = gtk
  44         TARGET_ARCH = pdaxrom               UI_TYPE = qt
  45         TARGET_ARCH = opensimpad-0.9.0      UI_TYPE = opie
  46         TARGET_ARCH = maemo                 UI_TYPE = maemo2
  47         TARGET_ARCH = maemo                 UI_TYPE = maemo4
  48         TARGET_ARCH = pma400                UI_TYPE = qtopia
  49         TARGET_ARCH = moto                  UI_TYPE = ezx
  50         TARGET_ARCH = win32                 UI_TYPE = win32
  51
  52   ** makefiles/arch/$(TARGET_ARCH).mk
  53      This file defines compiler name and location, headers and libraries
  54      locations, compilation flags, installation path (for desktop), etc.
  55
  56 4. How to build.
  57
  58 Just type 'make' in FBReader root directory. (FBReader root directory ==
  59 directory containing this file.)
  60
  61 5. How to install.
  62
  63 If you want to install FBReader on your desktop computer, just run 'make install'
  64 as root in FBReader root directory.
  65
  66 If you want to create package for another platform, run 'make packages' in
  67 FBReader root directory.