summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2017-08-14 17:43:40 +0100
committerEmmanuele Bassi <ebassi@gnome.org>2017-08-14 22:23:09 +0100
commitd2af8231836397ebf82a3a3d6457a37fee8de98f (patch)
treee9b059c0882ddd63c8033e9a672689162a8a4a8c /CONTRIBUTING.md
parent0803ee2df463b3a599108b9e111cede16e18ee0a (diff)
downloadgtk+-d2af8231836397ebf82a3a3d6457a37fee8de98f.tar.gz
Rename 'HACKING' to 'CONTRIBUTING'
And remove redundant and obsolete information.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000..d9cb111810
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,40 @@
+If you want to hack on the GTK+ project, you'll need to have the development
+tools appropriate for your operating system, including:
+
+ - Python (2.7 or 3.x)
+ - Meson
+ - Ninja
+ - Gettext (19.7 or newer)
+ - a C99 compatible compiler
+
+Up-to-date instructions about developing GNOME applications and libraries
+can be found here:
+
+ https://developer.gnome.org
+
+Information about using git with GNOME can be found here:
+
+ https://wiki.gnome.org/Git
+
+In order to get Git GTK+ installed on your system, you need to have the
+required versions of all the GTK+ dependencies; typically, this means a
+recent version of GLib, Cairo, Pango, and ATK.
+
+**Note**: if you plan to push changes to back to the master repository and
+have a GNOME account, you want to use the following instead:
+
+```sh
+$ git clone ssh://<username>@git.gnome.org/git/gtk+
+```
+
+To compile the Git version of GTK+ on your system, you will need to
+configure your build using Meson:
+
+```sh
+$ meson _builddir .
+```
+
+For information about submitting patches and pushing changes to Git, see the
+`README.md` and `README.commits` files. In particular, don't, under any
+circumstances, push anything to Git before reading and understanding
+`README.commmits`.