Add a README file explaining what's going on, and the examples DIR containing a HTML...
[plasmaplugin.git] / README
bloba6d212182bfb9a943a1d7ac17f82694af630d8c8
1 Plasmaplugin is a Netscape API browser plugin that embeds plasmoids in a web page.
2 It is known to work in Firefox 2.0 on linux so far.
4 You need a KDE build environment for trunk (4.1) set up to build this. I recommend
5 using cmakekde as described at http://techbase.kde.org to build it (WORKSFORME :)).
7 Its very early (and the licensing is a bit screwed up atm - the Trolltech component
8 its based on appears to be under GPL 2.0 only (whereas the other bits of it are under
9 BSD license... anyone can help sort that out, please do, as I don't really know what's
10 possible/legal...
12 Please give it a try and have fun and maybe even help improve it!
14 Running cmake on it will produce a nsplugin (libplasmaplugin.so), a demo app
15 which can be used to help debugging (just initializes the plugin, but outside
16 of the browser) and in the examples/ subdir, is an HTML file that demonstrates
17 the plugins capabilities.
19 The plugin and debugging app are installed by defualt to ~/.mozilla/plugins
20 as that WORKSFORME... you might need to move it around if about:plugins doesn't
21 show it up for you.
23 P.s. this uses XEmbed, so afaik doesn't work in Konqueror atm...