updated HACKING info

This commit is contained in:
Martin Willi 2009-07-07 17:26:16 +02:00
parent efb4bb248f
commit c99227630c
1 changed files with 17 additions and 26 deletions

43
HACKING
View File

@ -2,29 +2,24 @@
strongSwan - Development strongSwan - Development
------------------------- -------------------------
Subversion repository Git repository
--------------------- ---------------------
For interested developers, we have a public repository. To check out and For interested developers, we have a public repository. To check out and
compile the code, you need the following tools: compile the code, you need the following tools:
- Subversion (1.3.1) - Git
- a recent GNU C complier (gcc-3.4.6) - a recent GNU C complier (>= 3.x)
- recent autotools (autoconf-2.59, automake-1.9.6, libtool-1.5.22) - recent autotools
- the usual strongSwan dependencies (gmp >= 4.1.4, optional curl, ldap) - perl
- perl (5.8.8) - lex/flex
- lex (flex-2.5.33) - yacc/bison
- yacc (bison-2.1) - gperf
- gperf (3.0.1) - optionally Doxygen
- Doxygen (1.4.6)
The numbers in brackets represent the versions used on our development systems, To check out the master branch, use:
other version MAY work, too. Not all tools are checked by the configure script,
as they are not needed in the tarball distributions, so check them manually.
To check out the trunk, use: git clone http://git.strongswan.org/strongswan.git
svn co http://www.strongswan.org/ikev2/trunk strongswan
After a successful check out, give the autotools a try: After a successful check out, give the autotools a try:
@ -40,20 +35,16 @@ Then you're in, start the build as usual:
API documentation API documentation
----------------- -----------------
Charon and libstrongswan contain inline code documentation. These comments can Charon and libstrongswan contain inline code documentation. These comments can
be extracted using doxygen. It is built using 'make apidoc', which creates an be extracted using doxygen. It is built using 'make apidoc', which creates an
'apidoc' folder containing the HTML files. 'apidoc' folder containing the HTML files.
strongSwan wiki
---------------
uClibc support A wiki for users and developers, including ticket system and source browser
-------------- is available at
To run strongSwan on uClibc, you need at least: http://wiki.strongswan.org
String and Stdio Support --->
[*] Support glibc's register_printf_function()
General Library Settings --->
[*] Support global constructors and destructors
It is fairly untested yet, so don't except to get it running without
further tweaks.