3939824d11
This is an important document for newcomers, so we should err on the side of being more detailed on what kind of contributions we expect, and how we expect them. The text is heavily modelled on the contributing-template by Nadia Eghbal available here: https://github.com/nayafia/contributing-template |
||
|---|---|---|
| .gitlab/issue_templates | ||
| .gitlab-ci | ||
| build-aux | ||
| demos | ||
| docs | ||
| examples | ||
| gdk | ||
| gsk | ||
| gtk | ||
| modules | ||
| po | ||
| po-properties | ||
| subprojects | ||
| tests | ||
| testsuite | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| AUTHORS | ||
| config.h.meson | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| gtk.doap | ||
| gtk+-4.0.pc.in | ||
| gtk+-unix-print-4.0.pc.in | ||
| make-pot | ||
| meson_options.txt | ||
| meson.build | ||
| NEWS | ||
| NEWS.pre-1.0 | ||
| NEWS.pre-2.0 | ||
| NEWS.pre-3.0 | ||
| README.md | ||
GTK+ — The GTK toolkit
General information
GTK+ is a multi-platform toolkit for creating graphical user interfaces. Offering a complete set of widgets, GTK+ is suitable for projects ranging from small one-off projects to complete application suites.
GTK+ is free software and part of the GNU Project. However, the licensing terms for GTK+, the GNU LGPL, allow it to be used by all developers, including those developing proprietary software, without any license fees or royalties.
The official download location
The official web site
The official developers blog
Information about mailing lists can be found at
Nightly documentation can be found at
- Gtk: https://gnome.pages.gitlab.gnome.org/gtk/gtk/
- Gdk: https://gnome.pages.gitlab.gnome.org/gtk/gdk/
- Gsk: https://gnome.pages.gitlab.gnome.org/gtk/gsk/
Building and installing
In order to build GTK+ you will need:
You will also need various dependencies, based on the platform you are building for:
If you are building the X11 backend, you will also need:
- Xlib, and the following X extensions:
- xrandr
- xrender
- xi
- xext
- xfixes
- xcursor
- xdamage
- xcomposite
- atk-bridge-2.0
If you are building the Wayland backend, you will also need:
- Wayland-client
- Wayland-protocols
- Wayland-cursor
- Wayland-EGL
Once you have all the necessary dependencies, you can build GTK+ by using Meson:
$ meson _build .
$ cd _build
$ ninja
You can run the test suite using:
$ meson test
And, finally, you can install GTK+ using:
$ sudo ninja install
Complete information about installing GTK+ and related libraries can be found in the file:
docs/reference/gtk/html/gtk-building.html
Or online
How to report bugs
Bugs should be reported on the issues page.
In the bug report please include:
-
Information about your system. For instance:
- which version of GTK+ you are using
- what operating system and version
- for Linux, which distribution
- if you built GTK+, the list of options used to configure the build
And anything else you think is relevant.
-
How to reproduce the bug.
If you can reproduce it with one of the demo applications that are built in the demos/ subdirectory, on one of the test programs that are built in the tests/ subdirectory, that will be most convenient. Otherwise, please include a short test program that exhibits the behavior. As a last resort, you can also provide a pointer to a larger piece of software that can be downloaded.
-
If the bug was a crash, the exact text that was printed out when the crash occurred.
-
Further information such as stack traces may be useful, but is not necessary.
Release notes
The release notes for GTK+ are part of the migration guide in the API reference. See:
Licensing terms
GTK+ is released under the terms of the GNU Lesser General Public License, version 2.1 or, at your option, any later version, as published by the Free Software Foundation.
Please, see the COPYING file for further information.