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