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