Imported Upstream version 2.68.3
[platform/upstream/glib.git] / README.md
1 # GLib
2
3 GLib is the low-level core library that forms the basis for projects such
4 as GTK and GNOME. It provides data structure handling for C, portability
5 wrappers, and interfaces for such runtime functionality as an event loop,
6 threads, dynamic loading, and an object system.
7
8 The official download locations are:
9   <https://download.gnome.org/sources/glib>
10
11 The official web site is:
12   <https://www.gtk.org/>
13
14 ## Installation
15
16 See the file '[INSTALL.in](INSTALL.in)'
17
18 ## How to report bugs
19
20 Bugs should be reported to the GNOME issue tracking system.
21 (<https://gitlab.gnome.org/GNOME/glib/issues/new>). You will need
22 to create an account for yourself.
23
24 In the bug report please include:
25
26 * Information about your system. For instance:
27   * What operating system and version
28   * For Linux, what version of the C library
29   * And anything else you think is relevant.
30 * How to reproduce the bug.
31   * If you can reproduce it with one of the test programs that are built
32   in the tests/ subdirectory, that will be most convenient.  Otherwise,
33   please include a short test program that exhibits the behavior.
34   As a last resort, you can also provide a pointer to a larger piece
35   of software that can be downloaded.
36 * If the bug was a crash, the exact text that was printed out
37   when the crash occurred.
38 * Further information such as stack traces may be useful, but
39   is not necessary.
40
41 ## Patches
42
43 Patches should also be submitted as merge requests to gitlab.gnome.org. If the
44 patch fixes an existing issue, please refer to the issue in your commit message
45 with the following notation (for issue 123):
46 Closes: #123
47
48 Otherwise, create a new merge request that introduces the change, filing a
49 separate issue is not required.