]> git.ipfire.org Git - people/ms/strongswan.git/blobdiff - HACKING
traffic-selector: Avoid out-of-bound array access when calculating range
[people/ms/strongswan.git] / HACKING
diff --git a/HACKING b/HACKING
index 3303790f787438d7198f0a009d914404abf7eab7..b691e205a8e6990ce7e13951ba31d6d789c39e4c 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,27 +1,37 @@
-                 -------------------------
-                  strongSwan - Development
-                 -------------------------
+                ------------------------
+                strongSwan - Development
+                ------------------------
 
-For interested developers, we have a public repository. To check out and 
-compile the code, you need the following tools:
+Git repository
+---------------------
 
-    - Subversion (1.3.1)
-    - a recent GNU C complier (gcc-3.4.6)
-    - recent autotools (autoconf-2.59, automake-1.9.6, libtool-1.5.22)
-    - the usual strongSwan dependencies (gmp >= 4.1.4, optional curl, ldap)
-    - perl (5.8.8)
-    - lex (flex-2.5.33)
-    - yacc (bison-2.1)
-    - gperf (3.0.1)
-    - Doxygen (1.4.6)
+For interested developers, we have a public repository. To check out and compile
+the code, you need the following tools:
 
-The numbers in brackets represent the versions used on our development systems,
-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.
+    - Git
+    - a recent GNU C compiler (>= 3.x)
+    - automake
+    - autoconf
+    - libtool
+    - pkg-config
+    - gettext
+    - perl
+    - python
+    - lex/flex
+    - yacc/bison
+    - gperf
 
-To check out the trunk, use:
+    Optionally:
+    - lcov/genhtml
+    - Doxygen
 
-    svn co http://www.strongswan.org/ikev2/trunk strongswan
+To check out the master branch, use:
+
+    git clone git://git.strongswan.org/strongswan.git
+
+or using HTTP:
+
+    git clone https://git.strongswan.org/strongswan.git
 
 After a successful check out, give the autotools a try:
 
@@ -33,3 +43,20 @@ 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
+
+    https://wiki.strongswan.org
+