INSTALL

   1 libgcal INSTALL
   2 cavalcantii@gmail.com
   3
   4 == Compile and install ==
   5
   6 Dependencies: gcc, automake, libxml-dev, libcurl-dev, ca-certificates
   7
   8
   9 In the project root directory, run:
  10
  11 $autoreconf -i -f
  12
  13 $mkdir build #its a good practice not polute source directory
  14              #with binary objects
  15
  16 $cd build
  17
  18 $../configure
  19
  20 $make
  21
  22 $sudo make install
  23
  24
  25
  26 == Development ==
  27
  28 Dependencies: lcov, gcov, check, doxygen, dot
  29
  30 Do the same but you can also add:
  31
  32 $../configure --enable-devel #enable unit tests and other flags
  33
  34
  35 **Attention**: There is an issue with efence in Ubuntu Hardy (mprotect fails),
  36 you should run instead
  37
  38 **$../configure --enable-warnings --enable-check --enable-lcov**
  39
  40
  41
  42
  43 $make lcov #runs unit test and create coverage reports
  44
  45 $make doxygen #generates API documentation
  46
  47
  48 ps1: If you wish just to run just a suite case, set GCAL environment
  49 variable (core|user|xml|screw) and GCALTEST variable for core module
  50 testing (gcal|xpath|edit|contact|debug|query).
  51
  52
  53 ps2: you can format this document to HTML running
  54
  55 $txt2tags -t html INSTALL
  56
  57
  58 ps3: ATTENTION utest will not run on source directory.
  59
  60 ps4: Currently I have being using cmake as the official development buildsystem
  61 (just run: make build; cd build; cmake ..; make)
  62
  63 ps5: Libgcal is already included in major Linux distros (Debian, OpenSuse,
  64 Ubuntu, etc) and FreeBSD
  65