18:36. incorporated proposed cleanups from gtk-devel-list.
[platform/upstream/glib.git] / README
1  *** IMPORTANT *** 
2
3 This is a development version of GLib.  You should be using a stable
4 version, which is available at ftp://ftp.gtk.org/pub/gtk/v1.2/.  This
5 version is meant for developers of GLib only:
6
7  * You should not base stable software on this version of GLib.
8  * GNOME developers should use a stable version of GLib.
9
10 Distributions should *NOT* ship a development package of this GLib.
11 Do not ship the headers and do not ship the glib-config script.  These
12 things will conflict with the stable 1.2 series.  Package only enough
13 to satisfy the requirements of some other package.  Package only the
14 library itself.  Doing otherwise will do no favors to the community.
15
16 If you install this version of GLib, we strongly recommend that you
17 install it in a different prefix than GLib 1.2.  Use --prefix as an
18 argument to configure to do this.  Otherwise, you will not be able to
19 do development with GLib 1.2 any longer.
20
21 *** You should be using GLib 1.2 instead. ***
22
23
24 General Information
25 ===================
26
27 This is GLib version 1.3.1. GLib is a library which includes support
28 routines for C such as lists, trees, hashes, memory allocation, and
29 many other things.
30
31 The official ftp site is:
32   ftp://ftp.gtk.org/pub/gtk
33
34 The official web site is:
35   http://www.gtk.org/
36
37 A mailing list is located at:
38   gtk-list@redhat.com
39
40 To subscribe: mail -s subscribe gtk-list-request@redhat.com < /dev/null
41 (Send mail to gtk-list-request@redhat.com with the subject "subscribe")
42
43 Installation
44 ============
45
46 See the file 'INSTALL'
47
48 How to report bugs
49 ==================
50
51 To report a bug, send mail either to gtk-list, as mentioned
52 above, or to gtk-bugs@gtk.org. If you send mail to gtk-list, you
53 must be subscribed yourself.
54
55 In the mail include:
56
57 * The version of GLib
58
59 * Information about your system. For instance:
60
61    - What operating system and version
62    - What version of X
63    - For Linux, what version of the C library
64
65   And anything else you think is relevant.
66
67 * How to reproduce the bug. 
68
69   If you can reproduce it with the testglib program that is built 
70   in the glib/ directory, that will be most convenient.  Otherwise, 
71   please include a short test program that exhibits the behavior. 
72   As a last resort, you can also provide a pointer to a larger piece 
73   of software that can be downloaded.
74
75 * If the bug was a crash, the exact text that was printed out
76   when the crash occured.
77
78 * Further information such as stack traces may be useful, but
79   is not necessary.
80
81 Patches
82 =======
83
84 Patches can be uploaded to the incoming/ directory on
85 ftp.gtk.org.  Please follow the instructions there, and include
86 your name and email address in the README file.
87
88 If the patch fixes a bug, it is usually a good idea to include
89 all the information described in "How to Report Bugs".