Go to file

Pierre Pronchery e8e96ac710 Fix panel-notify(1) and further tools		2015-09-03 00:50:47 +02:00
data	Reflect updates from upstream	2015-08-23 17:44:05 +02:00
doc	Begin to document panel.conf	2015-06-18 02:28:41 -04:00
include	Update the copyright notices	2015-07-31 22:06:01 +02:00
po	Reflect updates from upstream	2015-08-23 17:44:05 +02:00
src	Code cleanup	2015-09-03 00:48:47 +02:00
tests	Fix wifibrowser(1)	2015-09-01 02:50:49 +02:00
tools	Fix panel-notify(1) and further tools	2015-09-03 00:50:47 +02:00
.gitignore	Add config.{h,sh}	2015-04-04 17:03:22 +02:00
COPYING	Added GPL version 3 license terms	2010-07-25 07:59:02 +00:00
project.conf	Prepare the 0.3.2 release	2015-08-11 01:33:02 +02:00
README.md	Also ship a README file (in Markdown format)	2015-04-04 15:46:56 +02:00

README.md

DeforaOS Panel

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.

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

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
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:

$ make

On some systems, the Makefiles shipped can be re-generated accordingly thanks to the DeforaOS configure tool.

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.

Extending Panel

Applets for the Panel program can be written according to the API definitions installed and found in <Desktop/Panel.h> (here in include/Panel.h).

A sample applet can be found in src/applets/template.c.

Further applets can also be found in the DeforaOS Integration project.

Distributing Panel

DeforaOS Panel is subject to the terms of the GPL license, version 3. Please see the COPYING file for more information.