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