Update README file with details of getting it working on Windows.
[plasmaplugin.git] / README
blobbc122fe443cb561f677d88f7bfd70386322c9c1b
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 and Firefox 3.0 on Windows Vista x32.
4 Please give it a try and have fun and maybe even help improve it!
6 LINUX
7 =====
8 You need a KDE build environment for trunk (4.2) set up to build this. I recommend
9 using cmakekde as described at http://techbase.kde.org to build it (WORKSFORME :)).
11 Running cmake on it will produce a nsplugin (libplasmaplugin.so), a demo app
12 which can be used to help debugging (just initializes the plugin, but outside
13 of the browser) and in the examples/ subdir, is an HTML file that demonstrates
14 the plugins capabilities.
16 The plugin and debugging app are installed by defualt to ~/.mozilla/plugins
17 as that WORKSFORME... you might need to move it around if about:plugins doesn't
18 show it up for you.
20 P.s. this uses XEmbed, so afaik doesn't work in Konqueror atm...
22 WINDOWS
23 =======
24 You need KDE up to and including kdebase-workspace from trunk (4.2) compiled and
25 running with MinGW. Use the standard "mkdir build && cd build" "cmake .." "mingw32-make"
26 to build it. This should then compile OK, but will not install correctly.
27 To install it, you need to take the output file libplasmaplugin.dll and rename
28 it to nplibplasmaplugin.dll. Then copy it to your Firefox plugin directory and
29 restart Firefox. It should then work, but be warned that it crashes very easily.
31 I tried to get it working in Google Chrome, but gave up. If anyone can get it
32 running there please tell me! That would be very awesome...
34 OTHER INFORMATION
35 =================
37 Its very early (and the licensing is a bit screwed up atm - the Trolltech component
38 its based on appears to be under GPL 2.0 only (whereas the other bits of it are under
39 BSD license... anyone can help sort that out, please do, as I don't really know what's
40 possible/legal...