Skip to content

Commit 304d1d6

Browse files
committed
README.md: update the documentation
1 parent 66db9ce commit 304d1d6

File tree

1 file changed

+29
-18
lines changed

1 file changed

+29
-18
lines changed

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,52 @@ About Panel
55
-----------
66

77
This program is meant to display an arbitrary number of desktop panels, with
8-
support for one per edge of the screen at the moment. Each panel can then host a
9-
number of applets, implemented as plug-ins to the main program.
8+
support for up to one per edge of the screen at the moment. Each panel can then
9+
host a number of applets, implemented as plug-ins to the main program.
1010

1111
A number of additional utilities is also available, allowing tighter integration
1212
of external applications, as well as when responding to system events
1313
(notifications...).
1414

15-
Documentation
16-
-------------
17-
18-
Each of these tools, as well as Panel itself, are documented in a series of
19-
manual pages. They are also available in the HTML format.
20-
2115
Compiling Panel
2216
---------------
2317

24-
The current requirements for compiling Panel are as follows:
25-
* Gtk+ 2.4 or later, or Gtk+ 3.0 or later
18+
Panel depends on the following components:
19+
20+
* Gtk+ 2.4 or newer, or Gtk+ 3.0 or newer
2621
* DeforaOS libDesktop
2722
* DeforaOS Browser
2823
* an implementation of `make`
2924
* gettext (libintl) for translations
3025
* docbook-xsl for the documentation (optional)
3126

32-
With these installed, the following command should be enough to compile Panel on
33-
most systems:
27+
With these installed, the following command should be enough to compile and
28+
install Panel on most systems:
29+
30+
$ make install
31+
32+
To install (or package) Panel in a different location, use the `PREFIX` option
33+
as follows:
3434

35-
$ make
35+
$ make PREFIX="/another/prefix" install
3636

37-
On some systems, the Makefiles shipped can be re-generated accordingly thanks to
38-
the DeforaOS configure tool.
37+
Panel also supports `DESTDIR`, to be installed in a staging directory; for
38+
instance:
39+
40+
$ make DESTDIR="/staging/directory" PREFIX="/another/prefix" install
41+
42+
The compilation process supports a number of other options, such as OBJDIR for
43+
compilation outside of the source tree for instance.
44+
45+
On some systems, the Makefiles shipped may have to be re-generated accordingly.
46+
This can be performed with the DeforaOS configure tool.
47+
48+
Documentation
49+
-------------
3950

40-
The compilation process supports a number of options, such as PREFIX and DESTDIR
41-
for packaging and portability, or OBJDIR for compilation outside of the source
42-
tree.
51+
Manual pages for each of the executables installed are available in the `doc`
52+
folder. They are written in the DocBook-XML format, and need libxslt and
53+
DocBook-XSL to be installed for conversion to the HTML or man file format.
4354

4455
Extending Panel
4556
---------------

0 commit comments

Comments
 (0)