Replace doc/README.GIT with README-alpha.
[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 - 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
28 The required software is typically disitributed with your operating
29 system, and the instructions for installing them differ.  Here are
30 some hints:
31
32 gNewSense/Debian/Ubuntu:
33 sudo apt-get install git-core autoconf automake libtool gettext cvs 
34 sudo apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
35 sudo apt-get install help2man gtk-doc-tools valgrind
36 sudo apt-get install libgcrypt-dev guile-1.8-dev
37
38 To download the version controlled sources:
39
40 $ git clone git://git.savannah.gnu.org/gnutls.git
41 $ cd gnutls
42
43 The next step is to run autoreconf, ./configure, etc:
44
45 $ make bootstrap
46
47 Then build the project normally:
48
49 $ make
50 $ make check
51
52 Happy hacking!
53
54 ----------------------------------------------------------------------
55 Copying and distribution of this file, with or without modification,
56 are permitted in any medium without royalty provided the copyright
57 notice and this notice are preserved.