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.md](INSTALL.md)’. There is
  17 [separate and more in-depth documentation](./docs/win32-build.md) for building
  18 GLib on Windows.
  19
  20 ## Supported versions
  21
  22 Only the most recent unstable and stable release series are supported. All
  23 older versions are not supported upstream and may contain bugs, some of
  24 which may be exploitable security vulnerabilities.
  25
  26 See [SECURITY.md](SECURITY.md) for more details.
  27
  28 ## Documentation
  29
  30 API documentation is available online for GLib for the:
  31  * [GLib](https://docs.gtk.org/glib/)
  32  * [GObject](https://docs.gtk.org/gobject/)
  33  * [GModule](https://docs.gtk.org/gmodule/)
  34  * [GIO](https://docs.gtk.org/gio/)
  35
  36 ## Discussion
  37
  38 If you have a question about how to use GLib, seek help on [GNOME’s Discourse
  39 instance](https://discourse.gnome.org/tags/glib). Alternatively, ask a question
  40 on [StackOverflow and tag it `glib`](https://stackoverflow.com/questions/tagged/glib).
  41
  42 ## Reporting bugs
  43
  44 Bugs should be [reported to the GNOME issue tracking system](https://gitlab.gnome.org/GNOME/glib/issues/new).
  45 You will need to create an account for yourself. You may also submit bugs by
  46 e-mail (without an account) by e-mailing <incoming+gnome-glib-658-issue-@gitlab.gnome.org>,
  47 but this will give you a degraded experience.
  48
  49 Bugs are for reporting problems in GLib itself, not for asking questions about
  50 how to use it. To ask questions, use one of our [discussion forums](#discussion).
  51
  52 In bug reports please include:
  53
  54 * Information about your system. For instance:
  55   * What operating system and version
  56   * For Linux, what version of the C library
  57   * And anything else you think is relevant.
  58 * How to reproduce the bug.
  59   * If you can reproduce it with one of the test programs that are built
  60   in the `tests/` subdirectory, that will be most convenient.  Otherwise,
  61   please include a short test program that exhibits the behavior.
  62   As a last resort, you can also provide a pointer to a larger piece
  63   of software that can be downloaded.
  64 * If the bug was a crash, the exact text that was printed out
  65   when the crash occurred.
  66 * Further information such as stack traces may be useful, but
  67   is not necessary.
  68
  69 ## Contributing to GLib
  70
  71 Please follow the [contribution guide](./CONTRIBUTING.md) to know how to
  72 start contributing to GLib.
  73
  74 Patches should be [submitted as merge requests](https://gitlab.gnome.org/GNOME/glib/-/merge_requests/new)
  75 to gitlab.gnome.org. If the patch fixes an existing issue, please refer to the
  76 issue in your commit message with the following notation (for issue 123):
  77 ```
  78 Closes: #123
  79 ```
  80
  81 Otherwise, create a new merge request that introduces the change. Filing a
  82 separate issue is not required.
  83