summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README47
1 files changed, 47 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..bbd4395
--- /dev/null
+++ b/README
@@ -0,0 +1,47 @@
+mate-desktop
+=============
+
+mate-desktop contains the libmate-desktop library, the mate-about
+program as well as some desktop-wide documents.
+
+The libmate-desktop library provides API shared by several applications
+on the desktop, but that cannot live in the platform for various
+reasons. There is no API or ABI guarantee, although we are doing our
+best to provide stability. Documentation for the API is available with
+gtk-doc.
+
+The mate-about program helps find which version of MATE is installed.
+
+You may download updates to the package from:
+
+ http://download.gnome.org/sources/mate-desktop/
+
+To discuss mate-desktop, you may use the desktop-devel-list mailing
+list:
+
+ http://mail.gnome.org/mailman/listinfo/desktop-devel-list
+
+
+Installation
+============
+
+See the file 'INSTALL'. If you are not using a released version of
+mate-desktop (for example, if you checked out the code from git), you
+first need to run './autogen.sh'.
+
+
+How to report bugs
+==================
+
+Bugs should be reported to the MATE bug tracking system:
+
+ https://bugzilla.gnome.org/ (product mate-desktop)
+
+You will need to create an account for yourself.
+
+Please read the following page on how to prepare a useful bug report:
+
+ https://bugzilla.gnome.org/page.cgi?id=bug-writing.html
+
+Please read the HACKING file for information on where to send changes or
+bugfixes for this package.