]> git.ipfire.org Git - thirdparty/strongswan.git/blame - HACKING
gitignore: Don't ignore proposal_keywords.c
[thirdparty/strongswan.git] / HACKING
CommitLineData
53f8ac3d
TB
1 ------------------------
2 strongSwan - Development
3 ------------------------
c0d63ac9 4
c9922763 5Git repository
df18934d 6--------------
4986554f 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
df18934d 12 - gcc/clang
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
df18934d 28Check out the repository:
c0d63ac9 29
df18934d 30 git clone https://github.com/strongswan/strongswan.git
625b48b5 31
df18934d 32After a successful check out, run autotools to generate configure etc.:
c0d63ac9
MW
33
34 cd strongswan/
35 ./autogen.sh
36
df18934d 37Finally, start the build as usual:
c0d63ac9
MW
38
39 ./configure [options]
40 make
41 make install
4986554f
MW
42
43
432b298e
MW
44API documentation
45-----------------
c9922763 46
df18934d
TB
47All header files contain inline code documentation. These comments can be
48extracted using Doxygen via 'make apidoc', which creates an 'apidoc' folder
49containing the HTML files.
432b298e 50
df18934d
TB
51strongSwan Documentation
52------------------------
4986554f 53
df18934d 54Documentation for users and developers is available at
4986554f 55
df18934d 56 https://docs.strongswan.org