doc update
[gnutls.git] / README-alpha
blobd6ae3a4591a85ed404951226acb360b132de4f2c
1 GnuTLS README-alpha -- Information for developers.              -*- outline -*-
2 Copyright (C) 2009-2012 Free Software Foundation, Inc.
3 See the end for copying conditions.
5 This file contains instructions for developers and advanced users that
6 want to build from version controlled sources.
8 We require several tools to check out and build the software, including:
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 - libtasn1 <http://josefsson.org/libtasn1/> (optional)
29 - datefudge <http://packages.debian.org/datefudge> (optional)
30 - Libidn <http://www.gnu.org/software/libidn/> (optional, for crywrap)
31 - AWK <http://www.gnu.org/software/awk/> (for make dist, pmccabe2html)
32 - git2cl <http://josefsson.org/git2cl/> (for make dist, ChangeLog)
34 The required software is typically distributed with your operating
35 system, and the instructions for installing them differ.  Here are
36 some hints:
38 gNewSense/Debian/Ubuntu:
39 apt-get install git-core autoconf libtool gettext autopoint
40 apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
41 apt-get install help2man gtk-doc-tools valgrind
42 apt-get install guile-1.8-dev libtasn1-3-dev
43 apt-get install datefudge libidn11-dev gawk
45 You will sometimes need to install more recent versions of Automake,
46 Nettle, P11-kit and Autogen, which you will need to build from
47 sources.  If your system has the recent versions, you could do:
49 apt-get install automake autogen nettle-dev libp11-kit-dev
51 To download the version controlled sources:
53 $ git clone git://git.savannah.gnu.org/gnutls.git
54 $ cd gnutls
56 The next step is to run autoreconf (etc) and then ./configure:
58 $ make bootstrap
60 When built this way, some developer defaults will be enabled.  See
61 cfg.mk for details.
63 Then build the project normally:
65 $ make
66 $ make check
68 Happy hacking!
70 ----------------------------------------------------------------------
71 Copying and distribution of this file, with or without modification,
72 are permitted in any medium without royalty provided the copyright
73 notice and this notice are preserved.