[thirdparty/strongswan.git] / HACKING

                ------------------------
                strongSwan - Development
                ------------------------

Git repository
---------------------

For interested developers, we have a public repository. To check out and compile
the code, you need the following tools:

    - Git
    - a recent GNU C compiler (>= 3.x)
    - automake
    - autoconf
    - libtool
    - pkg-config
    - gettext
    - perl
    - python
    - lex/flex
    - yacc/bison
    - gperf

    Optionally:
    - lcov/genhtml
    - Doxygen

To check out the master branch, use:

    git clone git://git.strongswan.org/strongswan.git

or using HTTP:

    git clone http://git.strongswan.org/strongswan.git

After a successful check out, give the autotools a try:

    cd strongswan/
    ./autogen.sh

Then you're in, start the build as usual:

    ./configure [options]
    make
    make install


API documentation
-----------------

Charon and libstrongswan contain inline code documentation. These comments can
be extracted using doxygen. It is built using 'make apidoc', which creates an
'apidoc' folder containing the HTML files.

strongSwan wiki
---------------

A wiki for users and developers, including ticket system and source browser
is available at

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