README - LiNsta_XCPUMeter
===================

About:
======

LiNsta_XCPUMeter, an adesklet (http://adesklets.sourceforge.net), is a simple 
analogue system monitor (CPU, MEM and SWAP) for your desktop released under
GNU/GPL (See 'COPYING' file for license).
This adesklet contains code derived from the adeskclock adesklet, provided by
Jon McCormack <jonmack@users.sourceforge.net>
Some skins come from Gavatx (http://gavatx.deviantart.com/) and/or halfwayglad
(http://halfwayglad.deviantart.com/). I obtained their authorization to use
and share them. So these skins are licensed under a Creative Commons
Attribution-Non commercial-No Derivative Works 2.5 License.

Authors:
========

ETIENNE ALAURENT <etienne.alaurent@free.fr> FOR THIS ORIGINAL CODE.

Jon McCormack <jonmack@users.sourceforge.net> for code related to hands placement.

Requirements:
=============

Initially developed and tested using 
 - adesklets 0.5
 - linux 2.6.15-28 (Ubuntu 6.06 aka Dapper Drake)
 - gcc 4 
 - python 2.4

Running:
========

Simply run the 'LiNstaXCPUMeter.py' script from within its containing directory.
If you don't see anything then run 'LiNstaXCPUMeter.py --nautilus' if you are on GNOME,
or 'LiNstaXCPUMeter.py --kde' or something like that (not tested) - see documentation.

Use custom right-click menu to change skins or other things.

Version History:
================

v0.0.1
- First released version.
- Can't choose skin from the custom rigth-click menu

Files and Config files:
===================

Files and dir structure:
------------------------------------
LiNsta_XCPUMeter : LiNstaXCPUMeter.py (the adesklet), config.txt (general config file),
 I                             legal and doc files
 I--- skins : skins directory
     I--- skin1 : one dir for one skin
     I--- skin2 : one dir for one skin
       ...

In a skin dir: only gfx files (no config file - have to be changed in a new version) :
     + CPUMeter.png : the system monitor face image
     + Rotator.png : the big hand image, used for CPU monitoring
     + RotatorRAM.png : the small hand image, used for RAM and disk monitoring
     + Rotator_shadow.png,  RotatorRAM_shadow.png: the shadow images (not needed
         if you don't want them)
   Rotator.png and Rotator_shadow.png must have the same size.
   RotatorRAM.png and RotatorRAM_shadow.png must have the same size.

Config files:
-------------------

All config files are python dictionaries.

General config file : config.txt in base dir.
 - delay: time update in second. Smallest and default value : 1.
 - showValues: show or hide the values. Possible values : True or False.
   Changed when selecting the right option in the custom right-click menu.
 - theme: the skin to use. Must be the name of the dir containing skin files.
 - txt_font: text font used.
 - txt_color: text color used.
 - txt_alarm_color: alarm text color (when CPU activity > 80%, when MEM and
   SWAP > 80%). 
 - shadow_color: shadow text color.

The Future:
===================

 - make a better config system - easy.
 - change skin with custom right-click menu.
 - GTK+ window to configure the desklet. Difficult : adesklet api compatible with
   GTK+/GNOME python api ?
 - build a real sidebar with plugins. Every plugin is a widget. Total code rewrite needed.

===================
