HACKING

   1                  -------------------------
   2                   strongSwan - Development
   3                  -------------------------
   4
   5 Git repository
   6 ---------------------
   7
   8 For interested developers, we have a public repository. To check out and compile
   9 the code, you need the following tools:
  10
  11     - Git
  12     - a recent GNU C compiler (>= 3.x)
  13     - automake
  14     - autoconf
  15     - libtool
  16     - gettext
  17     - perl
  18     - lex/flex
  19     - yacc/bison
  20     - gperf
  21
  22     Optionally:
  23     - lcov/genhtml
  24     - Doxygen
  25
  26 To check out the master branch, use:
  27
  28    git clone git://git.strongswan.org/strongswan.git
  29
  30      or using HTTP
  31
  32    git clone http://git.strongswan.org/strongswan.git
  33
  34 After a successful check out, give the autotools a try:
  35
  36     cd strongswan/
  37     ./autogen.sh
  38
  39 Then you're in, start the build as usual:
  40
  41     ./configure [options]
  42     make
  43     make install
  44
  45
  46 API documentation
  47 -----------------
  48
  49 Charon and libstrongswan contain inline code documentation. These comments can
  50 be extracted using doxygen. It is built using 'make apidoc', which creates an
  51 'apidoc' folder containing the HTML files.
  52
  53 strongSwan wiki
  54 ---------------
  55
  56 A wiki for users and developers, including ticket system and source browser
  57 is available at
  58
  59     http://wiki.strongswan.org
  60