]> git.ipfire.org Git - thirdparty/strongswan.git/blame - HACKING
conf: Only install config snippets for enabled components
[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:
1f14b4a1
TB
23 - lcov/genhtml
24 - Doxygen
c0d63ac9 25
c9922763 26To check out the master branch, use:
c0d63ac9 27
625b48b5
MW
28 git clone git://git.strongswan.org/strongswan.git
29
30 or using HTTP
31
c9922763 32 git clone http://git.strongswan.org/strongswan.git
c0d63ac9
MW
33
34After a successful check out, give the autotools a try:
35
36 cd strongswan/
37 ./autogen.sh
38
39Then you're in, start the build as usual:
40
41 ./configure [options]
42 make
43 make install
4986554f
MW
44
45
432b298e
MW
46API documentation
47-----------------
c9922763 48
5ed3e3a7 49Charon and libstrongswan contain inline code documentation. These comments can
e3606f2b
MW
50be extracted using doxygen. It is built using 'make apidoc', which creates an
51'apidoc' folder containing the HTML files.
432b298e 52
c9922763
MW
53strongSwan wiki
54---------------
432b298e 55
c9922763
MW
56A wiki for users and developers, including ticket system and source browser
57is available at
4986554f 58
c9922763 59 http://wiki.strongswan.org
4986554f 60