Add.
[gnutls:gnutls.git] / README-alpha
1 GNU TLS README-alpha -- Information for developers.             -*- outline -*-
2 Copyright (C) 2009 Simon Josefsson
3 See the end for copying conditions.
4
5 This file contains instructions for developers and advanced users that
6 wants to build from version controlled sources.
7
8 We require several tools to build the software, including:
9
10 - Automake <http://www.gnu.org/software/automake/>
11 - Autoconf <http://www.gnu.org/software/autoconf/>
12 - Libtool <http://www.gnu.org/software/libtool/>
13 - Gettext <http://www.gnu.org/software/gettext/>
14 - Texinfo <http://www.gnu.org/software/texinfo/>
15 - help2man <http://www.gnu.org/software/help2man/>
16 - libgcrypt <http://www.gnupg.org/>
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.or.cz/>
23 - Perl <http://www.cpan.org/>
24 - Valgrind <http://valgrind.org/> (optional)
25
26 The required software is typically disitributed with your operating
27 system, and the instructions for installing them differ.  Here are
28 some hints:
29
30 gNewSense/Debian/Ubuntu:
31 sudo apt-get install git-core autoconf automake libtool gettext cvs texinfo help2man valgrind texlive texlive-generic-recommended texlive-extra-utils gtk-doc-tools libgcrypt-dev
32
33 To download the version controlled sources:
34
35 $ git clone git://git.savannah.gnu.org/gnutls.git
36 $ cd gnutls
37
38 The next step is to run autoreconf, ./configure, etc:
39
40 $ make bootstrap
41
42 Then build the project normally:
43
44 $ make
45 $ make check
46
47 Happy hacking!
48
49 ----------------------------------------------------------------------
50 Copying and distribution of this file, with or without modification,
51 are permitted in any medium without royalty provided the copyright
52 notice and this notice are preserved.