diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000000..ea70faa340 --- /dev/null +++ b/README.md @@ -0,0 +1,113 @@ +GnuTLS README-alpha -- Information for developers +================================================= + +This file contains instructions for developers and advanced users that +want to build from version controlled sources. + +We require several tools to check out and build the software, including: + +* Make <http://www.gnu.org/software/make/> +* Automake <http://www.gnu.org/software/automake/> (use 1.11.3 or later) +* Autoconf <http://www.gnu.org/software/autoconf/> +* Autogen <http://www.gnu.org/software/autogen/> (use 5.16 or later) +* Libtool <http://www.gnu.org/software/libtool/> +* Gettext <http://www.gnu.org/software/gettext/> +* Texinfo <http://www.gnu.org/software/texinfo/> +* Tar <http://www.gnu.org/software/tar/> +* Gzip <http://www.gnu.org/software/gzip/> +* Texlive & epsf <http://www.tug.org/texlive/> (for PDF manual) +* CVS <http://www.gnu.org/software/cvs/> (for gettext autopoint) +* GTK-DOC <http://www.gtk.org/gtk-doc/> (for API manual) +* Git <http://git-scm.com/> +* Perl <http://www.cpan.org/> +* Valgrind <http://valgrind.org/> (optional) +* Nettle <http://www.lysator.liu.se/~nisse/nettle/> +* Guile <http://www.gnu.org/software/guile/> +* p11-kit <http://p11-glue.freedesktop.org/p11-kit.html> +* gperf <http://www.gnu.org/software/gperf/> +* libtasn1 <http://josefsson.org/libtasn1/> (optional) +* datefudge <http://packages.debian.org/datefudge> (optional) +* Libidn <http://www.gnu.org/software/libidn/> (optional, for internationalization of DNS) +* AWK <http://www.gnu.org/software/awk/> (for make dist, pmccabe2html) +* git2cl <http://savannah.nongnu.org/projects/git2cl/> (for make dist, ChangeLog) +* softhsm <http://www.opendnssec.org/softhsm/> (for testing smart card support) +* dieharder <http://www.phy.duke.edu/~rgb/General/dieharder.php> (for testing PRNG) +* bison <http://www.gnu.org/software/bison> (for datetime parser in certtool) +* libunbound <https://unbound.net/> (for DANE support) +* nodejs <http://nodejs.org/> (needed for certain test cases) +* abi-compliance-checker <http://ispras.linuxbase.org/index.php/ABI_compliance_checker> (for make dist) + +The required software is typically distributed with your operating +system, and the instructions for installing them differ. Here are +some hints: + +gNewSense/Debian/Ubuntu: +``` +apt-get install git-core autoconf libtool gettext autopoint +apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils +apt-get install help2man gtk-doc-tools valgrind +apt-get install guile-2.0-dev libtasn1-6-dev +apt-get install libidn11-dev gawk gperf +apt-get install libunbound-dev dns-root-data bison +``` + +You will sometimes need to install more recent versions of Automake, +Nettle, P11-kit and Autogen, which you will need to build from +sources. If your system has the recent versions, you could do: + +``` +apt-get install automake autogen nettle-dev libp11-kit-dev +``` + +For basic interoperability testing you may want to install openssl +and polarssl. The packages below are used during make check. + +``` +apt-get install libpolarssl-runtime openssl +apt-get install nodejs softhsm datefudge +``` + +To download the version controlled sources: + +``` +$ git clone git://gitorious.org/gnutls/gnutls.git +$ cd gnutls +``` + +The next step is to run autoreconf (etc) and then ./configure: + +``` +$ make bootstrap +``` + +When built this way, some developer defaults will be enabled. See +cfg.mk for details. + +Then build the project normally: + +``` +$ make +$ make check +``` + +Individual tests that may require additional hardware (e.g., smart cards) +are: +``` +$ sh tests/suite/testpkcs11 +``` + +If you wish to contribute, you may read more about our coding style in +doc/README.CODING_STYLE. Note that when contributing code that is not +assigned to FSF, you will need to assert that the contribution is in +accordance to the "Developer's Certificate of Origin" as found in the +file doc/DCO.txt. That can be done by sending a mail with your real name to +the gnutls-devel mailing list. Then just make sure that your contributions +(patches), contain a "Signed-off-by" line, with your name and e-mail address. +To automate the process use "git am -s" to produce patches. + +Happy hacking! + +---------------------------------------------------------------------- +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. |