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