]> git.ipfire.org Git - thirdparty/strongswan.git/blame - HACKING
Add --enable-coverage configure option
[thirdparty/strongswan.git] / HACKING
CommitLineData
c0d63ac9
MW
1 -------------------------
2 strongSwan - Development
3 -------------------------
4
c9922763 5Git repository
4986554f
MW
6---------------------
7
5ed3e3a7
AKR
8For interested developers, we have a public repository. To check out and compile
9the code, you need the following tools:
c0d63ac9 10
c9922763 11 - Git
f3bb1bd0 12 - a recent GNU C compiler (>= 3.x)
65c8bff7
MW
13 - automake
14 - autoconf
15 - libtool
16 - gettext
c9922763
MW
17 - perl
18 - lex/flex
19 - yacc/bison
20 - gperf
1f14b4a1
TB
21
22 Optionally:
0aa5a466 23 - check
1f14b4a1
TB
24 - lcov/genhtml
25 - Doxygen
c0d63ac9 26
c9922763 27To check out the master branch, use:
c0d63ac9 28
625b48b5
MW
29 git clone git://git.strongswan.org/strongswan.git
30
31 or using HTTP
32
c9922763 33 git clone http://git.strongswan.org/strongswan.git
c0d63ac9
MW
34
35After a successful check out, give the autotools a try:
36
37 cd strongswan/
38 ./autogen.sh
39
40Then you're in, start the build as usual:
41
42 ./configure [options]
43 make
44 make install
4986554f
MW
45
46
432b298e
MW
47API documentation
48-----------------
c9922763 49
5ed3e3a7 50Charon and libstrongswan contain inline code documentation. These comments can
e3606f2b
MW
51be extracted using doxygen. It is built using 'make apidoc', which creates an
52'apidoc' folder containing the HTML files.
432b298e 53
c9922763
MW
54strongSwan wiki
55---------------
432b298e 56
c9922763
MW
57A wiki for users and developers, including ticket system and source browser
58is available at
4986554f 59
c9922763 60 http://wiki.strongswan.org
4986554f 61