wmcube: bump to version 1.0.0.
[dockapps.git] / wmcube / README
blob44ddcf0cc383ca7acd510a611142b2244fcfb922
1 wmcube 1.0.0
2 ---------------------------------------------------------------
3 Author: Cezary M. Kruk
4         c.kruk@bigfoot.com
5         http://linux-bsd-unix.strefa.pl
7 wmCube 0.98
8 ---------------------------------------------------------------
9 Author: Robert Kling
10         robkli-8@student.luth.se
11         http://boombox.campus.luth.se
13 Contributors:
14         Thorsten Jens (thodi@et-inf.fho-emden.de)
15         Jakob Borg (email-adress goes here)
16         Dan Price (dp@rampant.org)
17         Brian Joseph Czapiga (rys@godsey.net)
18         Tai-hwa Liang (avatar@mmlab.cse.yzu.edu.tw)
19         Jared Smolens (jsmolens+@andrew.cmu.edu)
21 Description
22 ---------------------------------------------------------------
23 wmcube is a dockapp displaying a realtime rotating 3D object
24 (plugin) together with the current CPU load.  The speed of the
25 rotation depends on the CPU load.
27 Commands
28 ---------------------------------------------------------------
29 Display help:
31     $ wmcube -h
33 Run cube.wmc plugin from the current or default directory:
35     $ wmcube -o cube.wmc &
37 Run random plugin from the default directory:
39     $ wmcube &
41 Run random plugin from the current directory:
43     $ wmcube -o . &
45 Run sample.wmc plugin from the selected directory:
47     $ wmcube -o ~/myplugins/sample.wmc &
49 (The default directory is set to /usr/share/wmcube).
51 Mouse actions
52 ---------------------------------------------------------------
53 Display the next plugin (works with the directories including
54 the plugins):
56     click the center of the dockapp
58 Zoom the plugin out or in:
60     click - or +
62 Hide or show CPU usage:
64     click XX%
66 Files
67 ---------------------------------------------------------------
68 3D-objects  3D object files (plugins)
69 COPYING     GNU General Public License Version 3
70 CHANGES     Description of the changes
71 INSTALL     Installation instructions
72 README      This file
74 Bugs
75 ---------------------------------------------------------------
76 If you discover any bugs in this software, please send a
77 bugreport to c.kruk@bigfoot.com and describe the problem as
78 detailed as you can.
80 Copyright
81 ---------------------------------------------------------------
82 wmcube (C) 2014 by Cezary M. Kruk, Wrocław, Poland
83 wmCube (C) 2000-2001 by Robert Kling, Lulea, Sweden