makefile fixes
[blorb-thumbnailer.git] / README
blob16b41076723603f42e8266479eace07a1456ae72
1     "Blorb" is a nonsense word from a popular early 1980s work of IF
2     called Enchanter where it was the name of a magic spell whose
3     purpose was to "safely protect a small object as though in a
4     strong box." In the late 1990s, the name was borrowed for a
5     standard format for what might be called the wrapping and
6     packaging of IF. A typical Blorb archive produced by Inform
7     contains the "story file" -- the actual program for the game --
8     together with its library card and cover art.
10               -- Graham Nelson in "Writing with Inform" (Chapter 23.4)
12 This program uses that cover art to generate thumbnail previews for
13 GNOME's file manager. I hope it will be useful to the devotee and the
14 developer both.
16 DETAILS AND DEPENDENCIES
18 The command line utility "blorb-thumbnailer" uses the GDK-Pixbuf
19 library to load, scale, and save the cover in question. It's
20 accompanied by helper scripts and format specifications that tell
21 Nautilus (the file manager) how and when to invoke it.
23 To compile, you'll need a few pieces of infrastructure that don't
24 normally come with GNOME: gcc, make, pkg-config, and the GTK+
25 development headers. Translated for Debian or Ubuntu:
27     $ sudo apt-get build-essential libgtk2.0-dev
29 INSTALLATION
31     $ make
32     $ sudo make install
34 The second line installs the program and the manual; registers the
35 Blorb MIME type; and checks the appropriate keys into the GConf
36 settings database. To remove, unregister, and delete:
38     $ sudo make uninstall
40 ISSUES AND LIMITATIONS
42  * There's no generic "blorb" icon to represent files without covers.
44  * URIs aren't supported. In theory you could be browsing, say, the IF
45    Archive, via FTP, in Nautilus, and it would attempt to provide
46    thumbnails. For now I'd say, use IFDB instead.
48 AUTHOR
50     Lewis Gentry <8uuuuu@gmail.com>
51     http://lg.vblank.net/blorb/
53 LICENSE
55 GPLv3+ (see COPYING or <http://www.gnu.org/licenses/gpl.html>).
57 With one exception: the xdg-mime utility, which is released under an
58 Expat-style license; see "scripts/xdg-mime" for more information.