summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2020-02-20 18:17:56 +0100
committerBastien Nocera <hadess@hadess.net>2020-02-20 18:21:38 +0100
commita2086e27201d4123e374f5e2d09ad7a10067dd59 (patch)
treeab1fece20e58b8b5574a4854aa4ddddb724eb882 /README.md
parent568f3d23fe7a44408591c756a4a317fb947f87df (diff)
downloadshared-mime-info-a2086e27201d4123e374f5e2d09ad7a10067dd59.tar.gz
README: Rename README to README.md
Now that we don't need to keep the old filename for the autotools.
Diffstat (limited to 'README.md')
-rw-r--r--[l---------]README.md45
1 files changed, 44 insertions, 1 deletions
diff --git a/README.md b/README.md
index 100b9382..750ebd5a 120000..100644
--- a/README.md
+++ b/README.md
@@ -1 +1,44 @@
-README \ No newline at end of file
+# Shared MIME Info
+
+The shared-mime-info package contains:
+
+- The core database of common MIME types, their file extensions and icon names.
+- The update-mime-database command, used to extend the DB and install a new MIME data.
+- The freedesktop.org shared MIME database spec.
+
+It is used by GLib, GNOME, KDE, XFCE and many others.
+
+For more information about the database see the [Shared MIME Info Specification here](https://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec/).
+
+## Installation
+
+To install do:
+
+ $ ./configure --prefix=/usr --sysconfdir=/etc
+ $ make
+ $ sudo make install
+
+If you are building from git then you will have to run `./autogen.sh` first.
+
+It requires glib to be installed for building the update command.
+Additionally, it uses gettext and itstool for translations.
+This database is translated at Transifex.
+
+
+Please report bugs here:
+ https://gitlab.freedesktop.org/xdg/shared-mime-info/issues
+
+Getting involved in freedesktop.org projects guide:
+ https://www.freedesktop.org/wiki/GettingInvolved/
+
+
+## Useful reference links
+
+IANA:
+ https://www.iana.org/assignments/media-types/
+
+KDE's old mime-types:
+ http://websvn.kde.org/branches/KDE/3.5/kdelibs/mimetypes/
+
+UNIX file tool and libmagic
+ https://github.com/file/file