Add HACKING, update README

3 files changed, 81 insertions, 3 deletions

diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..ae41802
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,31 @@
+Hacking on desktop-file-utils
+=============================
+
+ + The development occurs in git:
+
+     http://cgit.freedesktop.org/desktop-file-utils/
+
+   For information on how to access freedesktop.org git please read:
+
+     http://www.freedesktop.org/wiki/Infrastructure/git
+
+ + Please send patches as bug reports in freedesktop.org Bugzilla:
+
+     https://bugs.freedesktop.org/ (product desktop-file-utils)
+
+   Your patch should be in unified diff form (the -u option to GNU
+   diff). See also:
+
+     http://live.gnome.org/GnomeLove/SubmittingPatches
+
+ + Please try and send a patch against a recent version of this package.
+   Patches against git master are most preferable.
+
+ + Don't commit any but the most trivial patches without approval.
+
+ + Exceptions to this are:
+
+   - Translators may commit basic i18n related patches to the build
+     setup.
+   - Build sheriff are welcome - in accordance with the relevant build
+     sheriff constraints.
diff --git a/Makefile.am b/Makefile.am
index 499c43c..2894c9f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2,6 +2,8 @@ SUBDIRS = src misc
 
 ACLOCAL_AMFLAGS = -I m4
 
+EXTRA_DIST = HACKING
+
 MAINTAINERCLEANFILES = \
 	$(srcdir)/aclocal.m4 \
 	$(srcdir)/config.guess \
diff --git a/README b/README
index b292bfa..76c9bd3 100644
--- a/README
+++ b/README
@@ -1,11 +1,56 @@
-Utilities for manipulating desktop files.
+desktop-file-utils
+==================
+
 http://www.freedesktop.org/wiki/Software/desktop-file-utils
 
+desktop-file-utils contains a few command line utilities for working
+with desktop entries. Right now, the only documentation is the --help
+output for the utilities.
+
 desktop-file-validate: validates a desktop file and prints warnings/errors
                        about desktop entry specification violations.
 
 desktop-file-install: installs a desktop file to the applications directory,
                       optionally munging it a bit in transit.
 
-More information about desktop files can be found at:
-http://freedesktop.org/wiki/Specifications/desktop-entry-spec
+update-desktop-database: updates the database containing a cache of
+                         MIME types handled by desktop files.
+
+More information about desktop files and the "Desktop Entry
+Specification" is available on:
+
+  http://freedesktop.org/wiki/Specifications/desktop-entry-spec
+  http://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html
+
+You may download updates to the package from:
+
+   http://www.freedesktop.org/software/desktop-file-utils/releases/
+
+To discuss desktop-file-utils, you may use the xdg mailing list:
+
+  http://lists.freedesktop.org/mailman/listinfo/xdg
+
+
+Installation
+============
+
+See the file 'INSTALL'. If you are not using a released version of
+desktop-file-utils (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 freedesktop.org bug tracking system:
+
+   https://bugs.freedesktop.org/ (product desktop-file-utils)
+
+You will need to create an account for yourself.
+
+Please read the following page on how to prepare a useful bug report:
+
+   https://bugs.freedesktop.org/page.cgi?id=bug-writing.html
+
+Please read the HACKING file for information on where to send changes or
+bugfixes for this package.