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     - gcc/clang
  13     - automake
  14     - autoconf
  15     - libtool
  16     - pkg-config
  17     - gettext
  18     - perl
  19     - python
  20     - lex/flex
  21     - yacc/bison
  22     - gperf
  23
  24     Optionally:
  25     - lcov/genhtml
  26     - Doxygen
  27
  28 Check out the repository:
  29
  30     git clone https://github.com/strongswan/strongswan.git
  31
  32 After a successful check out, run autotools to generate configure etc.:
  33
  34     cd strongswan/
  35     ./autogen.sh
  36
  37 Finally, start the build as usual:
  38
  39     ./configure [options]
  40     make
  41     make install
  42
  43
  44 API documentation
  45 -----------------
  46
  47 All header files contain inline code documentation. These comments can be
  48 extracted using Doxygen via 'make apidoc', which creates an 'apidoc' folder
  49 containing the HTML files.
  50
  51 strongSwan Documentation
  52 ------------------------
  53
  54 Documentation for users and developers is available at
  55
  56     https://docs.strongswan.org