ucw/doc/install.txt

   1 Installation of libucw
   2 ======================
   3
   4 Prerequisities
   5 --------------
   6 To build and run, you need:
   7
   8   -  The GNU toolchain (gcc 4.0 or newer is required)
   9   -  GNU bash 2.0 or newer
  10   -  Perl (any reasonably new version; 5.6.1 works for me)
  11   -  pkg-config
  12   -  Linux (porting to other systems should be easy)
  13   -  Libjpeg, libpng and libungif to support all image formats
  14      (jpeg, png and gif). These libraries can be replaced by libgif (gif)
  15      and GraphicsMagick >= 1.1 (jpeg, png, gif and possible more formats).
  16      See sherlock/default.cfg for related configuration switches.
  17
  18 Compiling
  19 ---------
  20 First of all, you need to run the `configure` script to set up compile-time
  21 options. If you want to compile the library with the default feature set,
  22 just use:
  23
  24         ./configure
  25
  26 If you need to set anything unusual, please consult <<configure:>> for details.
  27
  28 The defaults determined by the configure script should be correct on Linux/i386,
  29 on other architectures you will probably need to tweak the CPU detection section
  30 in `ucw/autoconf.cfg` and possibly also the typedefs in `ucw/config.h`.
  31
  32 Then run
  33
  34         make
  35
  36 which builds the whole package in the `run` directory and you can play there.
  37 If you want to install it anywhere else, just use
  38
  39 //TODO Implement the installation
  40
  41         make install INSTALL_DIR=/where/to/install