Merge branch 'tkm'
[strongswan.git] / 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     - check
22     - optionally Doxygen
23
24 To check out the master branch, use:
25
26    git clone git://git.strongswan.org/strongswan.git
27
28      or using HTTP
29
30    git clone http://git.strongswan.org/strongswan.git
31
32 After a successful check out, give the autotools a try:
33
34     cd strongswan/
35     ./autogen.sh
36
37 Then you're in, start the build as usual:
38
39     ./configure [options]
40     make
41     make install
42
43
44 API documentation
45 -----------------
46
47 Charon and libstrongswan contain inline code documentation. These comments can
48 be extracted using doxygen. It is built using 'make apidoc', which creates an
49 'apidoc' folder containing the HTML files.
50
51 strongSwan wiki
52 ---------------
53
54 A wiki for users and developers, including ticket system and source browser
55 is available at
56
57     http://wiki.strongswan.org
58