added softhsm dependency for testsuite
[gnutls:gnutls.git] / README-alpha
1 GnuTLS README-alpha -- Information for developers.              -*- outline -*-
2 Copyright (C) 2009-2012 Free Software Foundation, Inc.
3 See the end for copying conditions.
4
5 This file contains instructions for developers and advanced users that
6 want to build from version controlled sources.
7
8 We require several tools to check out and build the software, including:
9
10 - Make <http://www.gnu.org/software/make/>
11 - Automake <http://www.gnu.org/software/automake/> (use 1.11.3 or later)
12 - Autoconf <http://www.gnu.org/software/autoconf/>
13 - Autogen <http://www.gnu.org/software/autogen/> (use 5.16 or later)
14 - Libtool <http://www.gnu.org/software/libtool/>
15 - Gettext <http://www.gnu.org/software/gettext/>
16 - Texinfo <http://www.gnu.org/software/texinfo/>
17 - Tar <http://www.gnu.org/software/tar/>
18 - Gzip <http://www.gnu.org/software/gzip/>
19 - Texlive & epsf <http://www.tug.org/texlive/> (for PDF manual)
20 - CVS <http://www.gnu.org/software/cvs/> (for gettext autopoint)
21 - GTK-DOC <http://www.gtk.org/gtk-doc/> (for API manual)
22 - Git <http://git-scm.com/>
23 - Perl <http://www.cpan.org/>
24 - Valgrind <http://valgrind.org/> (optional)
25 - Nettle <http://www.lysator.liu.se/~nisse/nettle/>
26 - Guile <http://www.gnu.org/software/guile/>
27 - p11-kit <http://p11-glue.freedesktop.org/p11-kit.html>
28 - gperf <http://www.gnu.org/software/gperf/>
29 - libtasn1 <http://josefsson.org/libtasn1/> (optional)
30 - datefudge <http://packages.debian.org/datefudge> (optional)
31 - Libidn <http://www.gnu.org/software/libidn/> (optional, for crywrap)
32 - AWK <http://www.gnu.org/software/awk/> (for make dist, pmccabe2html)
33 - git2cl <http://savannah.nongnu.org/projects/git2cl/> (for make dist, ChangeLog)
34 - softhsm <http://www.opendnssec.org/softhsm/> (for testing smart card support)
35
36 The required software is typically distributed with your operating
37 system, and the instructions for installing them differ.  Here are
38 some hints:
39
40 gNewSense/Debian/Ubuntu:
41 apt-get install git-core autoconf libtool gettext autopoint
42 apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
43 apt-get install help2man gtk-doc-tools valgrind
44 apt-get install guile-1.8-dev libtasn1-3-dev
45 apt-get install datefudge libidn11-dev gawk gperf
46 apt-get install softhsm
47
48 You will sometimes need to install more recent versions of Automake,
49 Nettle, P11-kit and Autogen, which you will need to build from
50 sources.  If your system has the recent versions, you could do:
51
52 apt-get install automake autogen nettle-dev libp11-kit-dev
53
54 To download the version controlled sources:
55
56 $ git clone git://gitorious.org/gnutls/gnutls.git
57 $ cd gnutls
58
59 The next step is to run autoreconf (etc) and then ./configure:
60
61 $ make bootstrap
62
63 When built this way, some developer defaults will be enabled.  See
64 cfg.mk for details.
65
66 Then build the project normally:
67
68 $ make
69 $ make check
70
71 Individual tests that may require additional hardware (e.g., smart cards)
72 are:
73 $ sh tests/suite/testpkcs11
74
75 If you wish to contribute, you may read more about our coding style in
76 doc/README.CODING_STYLE. Note that when contributing code that is not 
77 assigned to FSF, you will need to assert that the contribution is in 
78 accordance to the "Developer's Certificate of Origin" as found in the 
79 file doc/DCO.txt. That can be done by sending a mail with your real name to 
80 the gnutls-devel mailing list. Then just make sure that your contributions 
81 (patches), contain a "Signed-off-by" line, with your name and e-mail address. 
82 To automate the process use "git am -s" to produce patches.
83
84 Happy hacking!
85
86 ----------------------------------------------------------------------
87 Copying and distribution of this file, with or without modification,
88 are permitted in any medium without royalty provided the copyright
89 notice and this notice are preserved.