Adding upstream version 0.8.0.
[debian/lxpanel.git] / README
diff --git a/README b/README
index ae4eb59..64e23b9 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,17 @@
 LXPanel is a lightweight X11 desktop panel.
 
-To install this program, two other packages are needed:
-  menu-cache, lxmenu-data.
+To build this program you need some development packages:
+  libtool 2.2 or newer, intltool, libgtk 2.18 or newer,
+  libfm-gtk 1.2 or newer, libwnck, libkeybinder.
+Optional development packages may be required to build some modules:
+  libmenu-cache,
+  libalsasound ('volumealsa' plugin isn't built if missing),
+  libindicator 0.3.0 ('indicator' plugin isn't built if missing),
+  wireless-tools (required to build 'netstat' plugin),
+  libxml-2.0 (required to build 'weather' plugin).
+
+To install this program, three other packages are needed:
+  menu-cache, libfm-gtk, lxmenu-data.
 Please install them before installing lxpanel.
 
 There are 2 programs contained in the package.
@@ -27,9 +37,12 @@ About Netstat and Netstatus plugins:
    replacement of netstatus plugin.  It aims to be more usable and resource
    efficient.  At the current stage, netstat runs only on Linux.
 
+
 About theming & lxpanel:
 
-1. In future, hardcoding should not be used for icon lookup. Instead, use Gtk's built-in functions to handle icon lookup. If necessary, provide a fallback (hardcoded) icon.
+1. LXPanel tries to use as much themed icons as possible.  Fallback icons
+   may be also provided if they are placed into $(datadir)/lxpanel/images
+   directory.  Few plugins already provide their fallback icons.
 
 2. Current icon names that can be themed specifically for lxpanel include:
        *"lxpanel-background"
@@ -40,8 +53,23 @@ About theming & lxpanel:
        *"numlock-off"
        *"scrllock-on"
        *"scrllock-off"
-       *"wincmd"
+       *"window-manager"
        *"ns-lock"
+       *"cpufreq-icon"
        *possibly more, as yet unfound.
 
 There are also a substantial amount of others, but they use the icon naming specification.
+
+3. You can also set theme for any plugin specifically using it's widget name
+    which is equal to plugin type.
+
+4. There is a specific RC file which can be loaded by LXPanel, it can be placed
+    as ~/.config/lxpanel/$PROFILE/gtkrc, where $PROFILE is the profile used on
+    the LXPanel start.
+
+
+About keyboard options translations in xkb plugin:
+
+The 'xkb' plugin can use translations from language packs that are present
+    in many distributions. To use it you should have language pack which
+    includes "xkeyboard-config" translations.