From b217a72b9f084f34d28e8ead3cecc0165e3ca36e Mon Sep 17 00:00:00 2001
From: Pierre Pronchery <khorben@defora.org>
Date: Sat, 21 Apr 2018 22:53:30 +0200
Subject: [PATCH] Also ship a README.md file

---
 README.md    | 41 +++++++++++++++++++++++++++++++++++++++++
 project.conf |  2 +-
 2 files changed, 42 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..536e371
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+DeforaOS libDesktop
+===================
+
+About libDesktop
+----------------
+
+libDesktop is a collection of compatibility and portability routines to help
+with the development of desktop applications using the Gtk+ toolkit.
+
+
+Compiling libDesktop
+--------------------
+
+With GCC, this should be enough:
+
+    $ make
+
+To install libDesktop in a dedicated directory, like `/path/to/libDesktop`:
+
+    $ make PREFIX="/path/to/libDesktop" install
+
+
+Using Gtk+ version 3
+--------------------
+
+libDesktop defaults to the version 2 of the Gtk+ toolkit. Alternatively, it is
+possible to re-generate the Makefiles for the Gtk+ 3 toolkit with `configure(1)`
+from the DeforaOS configure project, found at
+<https://www.defora.org/os/project/16/configure>. The procedure is then as
+follows:
+
+    $ $EDITOR data/libDesktop.pc.in
+    [replace "gtk+-2.0" with "gtk+-3.0"]
+    $ $EDITOR src/project.conf tests/project.conf tools/project.conf
+    [comment lines in and out as described]
+    $ make distclean
+    $ configure
+    $ make
+
+Please refer to the documentation of DeforaOS configure for further
+instructions.
diff --git a/project.conf b/project.conf
index 050b702..43ee98e 100644
--- a/project.conf
+++ b/project.conf
@@ -3,4 +3,4 @@ version=0.3.0
 config=h,sh
 
 subdirs=data,doc,include,src,tests,tools
-dist=Makefile,COPYING,config.h,config.sh
+dist=Makefile,COPYING,README.md,config.h,config.sh