give source files a directory of their own
[blorb-thumbnailer.git] / README
blob90548eca350e87f199c467f6159a08e24280603f
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: gcc, make,
24 pkg-config, and the GTK+ development headers. Different distributions
25 will bundle these in different ways: for Fedora, it's enough (as of
26 this writing) to install "gcc" and "gdk-pixbuf2-devel"; for Debian,
27 try "build-essential" and "libgtk2.0-dev"; and for Ubuntu, you may
28 only need the "libgdk-pixbuf2.0-dev" package.
30 INSTALLATION
32     $ make
33     $ sudo make install
35 The second line will install the program and the manual, register the
36 Blorb MIME type, and check in the appropriate handlers. To remove,
37 unregister, and delete:
39     $ sudo make uninstall
41 ISSUES AND LIMITATIONS
43  * There's no generic "blorb" icon to represent files without covers.
45  * URIs aren't supported. In theory you could be browsing, say, the IF
46    Archive, via FTP, in Nautilus, and it would attempt to provide
47    thumbnails. For now I'd say, use IFDB instead.
49 AUTHOR
51     Lewis Gentry <8uuuuu@gmail.com>
52     http://lg.vblank.net/blorb/
54 LICENSE
56 GPLv3+ (see COPYING or <http://www.gnu.org/licenses/gpl.html>).
58 With one exception: the xdg-mime utility, which is released under an
59 Expat-style license; see "scripts/xdg-mime" for more information.