Fix license.
[gnutls:gnutls.git] / README-alpha
1 GNU TLS README-alpha -- Information for developers.             -*- outline -*-
2 Copyright (C) 2009, 2010  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 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 - Tar <http://www.gnu.org/software/tar/>
17 - Gzip <http://www.gnu.org/software/gzip/>
18 - Texlive & epsf <http://www.tug.org/texlive/> (for PDF manual)
19 - CVS <http://www.gnu.org/software/cvs/> (for gettext autopoint)
20 - GTK-DOC <http://www.gtk.org/gtk-doc/> (for API manual)
21 - Git <http://git.or.cz/>
22 - Perl <http://www.cpan.org/>
23 - Valgrind <http://valgrind.org/> (optional)
24 - libgcrypt <http://www.gnupg.org/>
25 - Guile <http://www.gnu.org/software/guile/>
26 - Gaa <http://gaa.sf.net> (optional)
27 - libtasn1 <http://josefsson.org/libtasn1/> (optional)
28
29 The required software is typically distributed with your operating
30 system, and the instructions for installing them differ.  Here are
31 some hints:
32
33 gNewSense/Debian/Ubuntu:
34 sudo apt-get install git-core autoconf automake libtool gettext cvs 
35 sudo apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
36 sudo apt-get install help2man gtk-doc-tools valgrind
37 sudo apt-get install libgcrypt-dev guile-1.8-dev libtasn1-3-dev
38
39 To download the version controlled sources:
40
41 $ git clone git://git.savannah.gnu.org/gnutls.git
42 $ cd gnutls
43
44 The next step is to run autoreconf, ./configure, etc:
45
46 $ make bootstrap
47
48 Then build the project normally:
49
50 $ make
51 $ make check
52
53 Happy hacking!
54
55 ----------------------------------------------------------------------
56 Copying and distribution of this file, with or without modification,
57 are permitted in any medium without royalty provided the copyright
58 notice and this notice are preserved.