]> git.ipfire.org Git - thirdparty/strongswan.git/blame - HACKING
swanctl: Fix documentation of default value of hostaccess
[thirdparty/strongswan.git] / HACKING
CommitLineData
53f8ac3d
TB
1 ------------------------
2 strongSwan - Development
3 ------------------------
c0d63ac9 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
07d971ef 16 - pkg-config
65c8bff7 17 - gettext
c9922763 18 - perl
07d971ef 19 - python
c9922763
MW
20 - lex/flex
21 - yacc/bison
22 - gperf
1f14b4a1
TB
23
24 Optionally:
1f14b4a1
TB
25 - lcov/genhtml
26 - Doxygen
c0d63ac9 27
c9922763 28To check out the master branch, use:
c0d63ac9 29
53f8ac3d 30 git clone git://git.strongswan.org/strongswan.git
625b48b5 31
53f8ac3d 32or using HTTP:
625b48b5 33
e4a3ef2e 34 git clone https://git.strongswan.org/strongswan.git
c0d63ac9
MW
35
36After a successful check out, give the autotools a try:
37
38 cd strongswan/
39 ./autogen.sh
40
41Then you're in, start the build as usual:
42
43 ./configure [options]
44 make
45 make install
4986554f
MW
46
47
432b298e
MW
48API documentation
49-----------------
c9922763 50
5ed3e3a7 51Charon and libstrongswan contain inline code documentation. These comments can
e3606f2b
MW
52be extracted using doxygen. It is built using 'make apidoc', which creates an
53'apidoc' folder containing the HTML files.
432b298e 54
c9922763
MW
55strongSwan wiki
56---------------
432b298e 57
c9922763
MW
58A wiki for users and developers, including ticket system and source browser
59is available at
4986554f 60
e4a3ef2e 61 https://wiki.strongswan.org
4986554f 62