merging modularized kernel interface back to trunk

[strongswan.git] / HACKING

diff --git a/HACKING b/HACKING
index 3303790..b87faa3 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -2,6 +2,9 @@
                   strongSwan - Development
                  -------------------------
 
+Subversion repository
+---------------------
+
 For interested developers, we have a public repository. To check out and 
 compile the code, you need the following tools:
 
@@ -33,3 +36,24 @@ 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.
+
+
+uClibc support
+--------------
+
+To run strongSwan on uClibc, you need at least:
+
+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.