Code

tpdfview: Added simple presentation mode.
[tpdfview.git] / README
1 tpdfview
2 ========
4   tpdfview (tiny PDF viewer, or tokkee's PDF viewer, choose whatever you like
5   best) is a Portable Document Format (PDF) viewer. It was developed with
6   presentations and accompanying material in mind.
8   This is free and open source software, licensed under the 2-clause BSD
9   license. See COPYING for details.
11 Prerequisites
12 -------------
14   To compile the tpdfview package from source you need:
16   * A build environment: autotools, libtool, C compiler, ...
18   * A POSIX + Single UNIX Specification compatible C library.
20   * asciidoc, xsltproc:
21     The AsciiDoc text document format is used to write the manpages.
23   * libcairo:
24     The 2D vector graphics library is used for the actual drawing of the PDF
25     on screen.
27   * libgtk-2.0:
28     The cross-plattform GIMP Toolkit (GTK+) is used to create the graphical
29     user interface.
31   * libpoppler-glib:
32     The (GLib-based) PDF rendering library is used for handling the PDF files.
34 Configuring / Compiling / Installing
35 ------------------------------------
37   To configure, build and install tpdfview with the default settings, run
38   `./configure && make && make install'. For detailed, generic instructions
39   see INSTALL. For a complete list of configure options and their description,
40   run `./configure --help'.
42   By default, tpdfview will be installed into `/opt/tpdfview'. You can adjust
43   this setting by specifying the `--prefix' configure option - see INSTALL for
44   details. If you pass DESTDIR=<path> to `make install', <path> will be
45   prefixed to all installation directories. This might be useful when creating
46   packages for tpdfview.
48 Author
49 ------
51   Sebastian "tokkee" Harl <sh@tokkee.org>