From 304d1d663d97a178c109c76a4cfab7dd92c683d4 Mon Sep 17 00:00:00 2001
From: Pierre Pronchery <khorben@defora.org>
Date: Sat, 14 May 2022 01:12:23 +0200
Subject: [PATCH] README.md: update the documentation

---
 README.md | 47 +++++++++++++++++++++++++++++------------------
 1 file changed, 29 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index e215c9b..9ca44da 100644
--- a/README.md
+++ b/README.md
@@ -5,41 +5,52 @@ About Panel
 -----------
 
 This program is meant to display an arbitrary number of desktop panels, with
-support for one per edge of the screen at the moment. Each panel can then host a
-number of applets, implemented as plug-ins to the main program.
+support for up to one per edge of the screen at the moment. Each panel can then
+host a number of applets, implemented as plug-ins to the main program.
 
 A number of additional utilities is also available, allowing tighter integration
 of external applications, as well as when responding to system events
 (notifications...).
 
-Documentation
--------------
-
-Each of these tools, as well as Panel itself, are documented in a series of
-manual pages. They are also available in the HTML format.
-
 Compiling Panel
 ---------------
 
-The current requirements for compiling Panel are as follows:
- * Gtk+ 2.4 or later, or Gtk+ 3.0 or later
+Panel depends on the following components:
+
+ * Gtk+ 2.4 or newer, or Gtk+ 3.0 or newer
  * DeforaOS libDesktop
  * DeforaOS Browser
  * an implementation of `make`
  * gettext (libintl) for translations
  * docbook-xsl for the documentation (optional)
 
-With these installed, the following command should be enough to compile Panel on
-most systems:
+With these installed, the following command should be enough to compile and
+install Panel on most systems:
 
-    $ make
+    $ make install
 
-On some systems, the Makefiles shipped can be re-generated accordingly thanks to
-the DeforaOS configure tool.
+To install (or package) Panel in a different location, use the `PREFIX` option
+as follows:
 
-The compilation process supports a number of options, such as PREFIX and DESTDIR
-for packaging and portability, or OBJDIR for compilation outside of the source
-tree.
+    $ make PREFIX="/another/prefix" install
+
+Panel also supports `DESTDIR`, to be installed in a staging directory; for
+instance:
+
+    $ make DESTDIR="/staging/directory" PREFIX="/another/prefix" install
+
+The compilation process supports a number of other options, such as OBJDIR for
+compilation outside of the source tree for instance.
+
+On some systems, the Makefiles shipped may have to be re-generated accordingly.
+This can be performed with the DeforaOS configure tool.
+
+Documentation
+-------------
+
+Manual pages for each of the executables installed are available in the `doc`
+folder. They are written in the DocBook-XML format, and need libxslt and
+DocBook-XSL to be installed for conversion to the HTML or man file format.
 
 Extending Panel
 ---------------