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