Do not store auto-generated manpages to git.
[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 build the software, including:
9
10 - Make <http://www.gnu.org/software/make/>
11 - Automake <http://www.gnu.org/software/automake/>
12 - Autoconf <http://www.gnu.org/software/autoconf/>
13 - Autogen <http://www.gnu.org/software/autogen/>
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 - help2man <http://www.gnu.org/software/help2man/>
18 - Tar <http://www.gnu.org/software/tar/>
19 - Gzip <http://www.gnu.org/software/gzip/>
20 - Texlive & epsf <http://www.tug.org/texlive/> (for PDF manual)
21 - Gettext <http://www.gnu.org/software/cvs/> (for gettext autopoint)
22 - GTK-DOC <http://www.gtk.org/gtk-doc/> (for API manual)
23 - Git <http://git.or.cz/>
24 - Perl <http://www.cpan.org/>
25 - Valgrind <http://valgrind.org/> (optional)
26 - libgcrypt <http://www.gnupg.org/>
27 - Guile <http://www.gnu.org/software/guile/>
28 - Gaa <http://gaa.sf.net> (optional)
29 - libtasn1 <http://josefsson.org/libtasn1/> (optional)
30 - p11-kit <http://p11-glue.freedesktop.org/p11-kit.html>
31 - datefudge <http://packages.debian.org/datefudge> (optional)
32 - Libidn <http://www.gnu.org/software/libidn/> (optional, for crywrap)
33
34 The required software is typically distributed with your operating
35 system, and the instructions for installing them differ.  Here are
36 some hints:
37
38 gNewSense/Debian/Ubuntu:
39 sudo apt-get install git-core autoconf automake libtool gettext autopoint
40 sudo apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
41 sudo apt-get install help2man gtk-doc-tools valgrind
42 sudo apt-get install nettle-dev guile-1.8-dev libtasn1-3-dev libp11-kit-dev
43 sudo apt-get install datefudge libidn11-dev
44
45 To download the version controlled sources:
46
47 $ git clone git://git.savannah.gnu.org/gnutls.git
48 $ cd gnutls
49
50 The next step is to run autoreconf, ./configure, etc:
51
52 $ make bootstrap
53
54 Then build the project normally:
55
56 $ make
57 $ make check
58
59 Happy hacking!
60
61 ----------------------------------------------------------------------
62 Copying and distribution of this file, with or without modification,
63 are permitted in any medium without royalty provided the copyright
64 notice and this notice are preserved.