README.md
1DeforaOS Panel
2==============
3
4About Panel
5-----------
6
7This program is meant to display an arbitrary number of desktop panels, with
8support for one per edge of the screen at the moment. Each panel can then host a
9number of applets, implemented as plug-ins to the main program.
10
11A number of additional utilities is also available, allowing tighter integration
12of external applications, as well as when responding to system events
13(notifications...).
14
15Each of these tools, as well as Panel itself, are documented in a series of
16manual pages. They are also available in the HTML format.
17
18Compiling Panel
19---------------
20
21The current requirements for compiling Panel are as follows:
22 * Gtk+ 2.4 or later, or Gtk+ 3.0 or later
23 * DeforaOS libDesktop
24 * DeforaOS Browser
25 * an implementation of `make`
26 * gettext (libintl) for translations
27 * docbook-xsl for the documentation (optional)
28
29With these installed, the following command should be enough to compile Panel on
30most systems:
31
32 $ make
33
34On some systems, the Makefiles shipped can be re-generated accordingly thanks to
35the DeforaOS configure tool.
36
37The compilation process supports a number of options, such as PREFIX and DESTDIR
38for packaging and portability, or OBJDIR for compilation outside of the source
39tree.
40
41Extending Panel
42---------------
43
44Applets for the Panel program can be written according to the API definitions
45installed and found in <Desktop/Panel.h> (here in `include/Panel.h`).
46
47A sample applet can be found in `src/applets/template.c`.
48
49Further applets can also be found in the DeforaOS Integration project.
50
51Distributing Panel
52------------------
53
54DeforaOS Panel is subject to the terms of the GPL license, version 3. Please see
55the `COPYING` file for more information.
56