README-alpha

   1 Libidn README-alpha -- Important introductory notes for alpha releases.
   2 Copyright (C) 2002, 2003, 2004, 2005 Simon Josefsson
   3 See the end for copying conditions.
   4
   5 Libidn is unstable.  You should expect it to not work.  You should
   6 expect it to have security problems.  The API will likely change.
   7 This is the development release.  A proper release will be made in due
   8 time.  Let me repeat that, LIBIDN IS MOST LIKELY INSECURE. DO NOT USE
   9 IN A PRODUCTION ENVIRONMENT!
  10
  11 The code will go through a security review before the stable release
  12 is made.  Volunteers and/or donations needed.  The alpha release has
  13 been written for functionality, not security, as is painfully obvious.
  14 It is hoped that since this library is small it can be rewritten
  15 securely in-place.
  16
  17 It will not become stable without help.  Donate time or money.
  18
  19 To compile from CVS, you may need recent versions of perl, texinfo (>=
  20 4.7), gengetopt (>= 2.13), cvs2cl, help2man, autoconf (>= 2.59),
  21 automake (>= 1.9), libtool (>= 1.5.2), gtk-doc [1], doxygen, gcj,
  22 gjdoc, and gettext (>= 0.14.1).
  23
  24 Bootstrap the build environment using:
  25
  26   $ ./autogen.sh
  27
  28 Then run ./configure and make as usual.
  29
  30 [1] Apply the patch in
  31 <http://bugzilla.gnome.org/show_bug.cgi?id=156643> against GTK-DOC to
  32 avoid initial build errors like this:
  33
  34 make[4]: *** No rule to make target `tmpl/*.sgml', needed by `sgml-build.stamp'.  Stop.
  35
  36 ----------------------------------------------------------------------
  37 Copying and distribution of this file, with or without modification,
  38 are permitted in any medium without royalty provided the copyright
  39 notice and this notice are preserved.