beautified configure help output.
[platform/upstream/glib.git] / README.in
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 *** You should be using GLib 1.2 instead. ***
11
12
13 General Information
14 ===================
15
16 This is GLib version @GLIB_VERSION@. GLib is a library which includes support
17 routines for C such as lists, trees, hashes, memory allocation, and
18 many other things.
19
20 The official ftp site is:
21   ftp://ftp.gtk.org/pub/gtk
22
23 The official web site is:
24   http://www.gtk.org/
25
26 Information about mailing lists can be found at
27   http://www.gtk.org/mailinglists.html
28
29 To subscribe: mail -s subscribe gtk-list-request@gnome.org < /dev/null
30 (Send mail to gtk-list-request@gnome.org with the subject "subscribe")
31
32 Installation
33 ============
34
35 See the file 'INSTALL'
36
37 How to report bugs
38 ==================
39
40 Bugs should be reported to the GNOME bug tracking system. 
41 (http://bugzilla.gnome.org, product glib.) You will need
42 to create an account for yourself.
43
44 In the bug report please include:
45
46 * Information about your system. For instance:
47
48    - What operating system and version
49    - For Linux, what version of the C library
50
51   And anything else you think is relevant.
52
53 * How to reproduce the bug. 
54
55   If you can reproduce it with the testgtk program that is built 
56   in the gtk/ subdirectory, that will be most convenient.  Otherwise, 
57   please include a short test program that exhibits the behavior. 
58   As a last resort, you can also provide a pointer to a larger piece 
59   of software that can be downloaded.
60
61 * If the bug was a crash, the exact text that was printed out
62   when the crash occured.
63
64 * Further information such as stack traces may be useful, but
65   is not necessary.
66
67 Patches
68 =======
69
70 Patches should also be submitted to bugzilla.gnome.org. If the
71 patch fixes an existing bug, add the patch as an attachment
72 to that bug report.
73
74 Otherwise, enter a new bug report that describes the patch,
75 and attach the patch to that bug report.
76
77 Bug reports containing patches should include the PATCH keyword
78 in their keyword fields. If the patch adds to or changes the GLib 
79 programming interface, the API keyword should also be included.
80
81 Patches should be in unified diff form. (The -u option to GNU
82 diff.)