Skip to content

Commit

Permalink
README.md: update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
khorben committed May 13, 2022
1 parent 66db9ce commit 304d1d6
Showing 1 changed file with 29 additions and 18 deletions.
47 changes: 29 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 install

To install (or package) Panel in a different location, use the `PREFIX` option
as follows:

$ make
$ make PREFIX="/another/prefix" install

On some systems, the Makefiles shipped can be re-generated accordingly thanks to
the DeforaOS configure tool.
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
-------------

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.
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
---------------
Expand Down

0 comments on commit 304d1d6

Please sign in to comment.