github: Use tpm2-tss 3.2.3 for tests

[thirdparty/strongswan.git] / HACKING

diff --git a/HACKING b/HACKING
index 2e84792696fd8b7227438028a17f6707a2a0b811..6df43f33bb56d470a50be31fbe7d626ef9a6e7f2 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,20 +1,22 @@
-                 -------------------------
-                  strongSwan - Development
-                 -------------------------
+                ------------------------
+                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)
+    - gcc/clang
     - automake
     - autoconf
     - libtool
+    - pkg-config
     - gettext
     - perl
+    - python
     - lex/flex
     - yacc/bison
     - gperf
@@ -23,20 +25,16 @@ the code, you need the following tools:
     - lcov/genhtml
     - Doxygen
 
-To check out the master branch, use:
+Check out the repository:
 
-   git clone git://git.strongswan.org/strongswan.git
+    git clone https://github.com/strongswan/strongswan.git
 
-     or using HTTP
-
-   git clone http://git.strongswan.org/strongswan.git
-
-After a successful check out, give the autotools a try:
+After a successful check out, run autotools to generate configure etc.:
 
     cd strongswan/
     ./autogen.sh
 
-Then you're in, start the build as usual:
+Finally, start the build as usual:
 
     ./configure [options]
     make
@@ -46,15 +44,13 @@ Then you're in, start the build as usual:
 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
----------------
+All header files contain inline code documentation. These comments can be
+extracted using Doxygen via 'make apidoc', which creates an 'apidoc' folder
+containing the HTML files.
 
-A wiki for users and developers, including ticket system and source browser
-is available at
+strongSwan Documentation
+------------------------
 
-    http://wiki.strongswan.org
+Documentation for users and developers is available at
 
+    https://docs.strongswan.org