A generic Document Reader
Clone or download
Latest commit 914ee4a Jul 17, 2018
Permalink
Failed to load latest commit information.
.circleci Update CI configuration Jan 23, 2018
.github Create ISSUE_TEMPLATE.md Jul 4, 2017
backend BugFix #227 (#232) Jun 16, 2018
cut-n-paste ATRIL BACKPORTS: zoom-control.c: don't use deprecated gtk_combo_box_s… Aug 30, 2017
data Add the ability to zoom in/out thumbnails (#195) Feb 5, 2018
debian 1.8.5 Jul 17, 2018
help Remove caja/nemo extensions May 8, 2018
libdocument Remove caja/nemo extensions May 8, 2018
libmisc toolbar: Make further improvements Apr 10, 2017
libview Bug fix + Trailing space fix (#217) Apr 30, 2018
po l10n: Update translations Jun 26, 2018
previewer Revert "Correct Sidebar refresh" Nov 20, 2017
shell "sidebar-thumbnails: fix clunky scrolling" (#236) Jul 16, 2018
test Migration (source) Feb 8, 2016
thumbnailer Build: Remove unnecessary ev_get_locale_dir() Jun 19, 2017
.gitignore Remove caja/nemo extensions May 8, 2018
AUTHORS Updated project files Feb 8, 2016
COPYING inicial Nov 9, 2011
ChangeLog Add empty ChangeLog to allow build from git Apr 1, 2013
INSTALL Documentation: Add INSTALL, update README Nov 11, 2016
Makefile.am Remove caja/nemo extensions May 8, 2018
NEWS Updated project files Feb 8, 2016
README Remove caja/nemo extensions May 8, 2018
TODO Updated project files Feb 8, 2016
autogen.sh Migration (source) Feb 8, 2016
configure.ac 1.8.5 Jul 17, 2018
makepot Fixing #22: Moving po/makepot and po/xreader.pot to the root directory Sep 8, 2016
xreader-document.h EVINCE BACKPORTS: libdocument: Add deprecation macros Mar 7, 2017
xreader-document.pc.in ATRIL BACKPORTS: PART 1 OF "move to GTK+3 (>= 3.14), drop GTK+2 code … Mar 30, 2017
xreader-view.h Migration (source) Feb 8, 2016
xreader-view.pc.in Migration (source) Feb 8, 2016
xreader.pot l10n: Add missing l10n Jun 25, 2018

README

================================================================================
                                  XREADER
================================================================================


What is it?
-----------

Xreader is a document viewer capable of displaying multiple and single page
document formats like PDF and Postscript. For more general information about
Xreader please visit our website at https://github.com/linuxmint/xreader.

This software is licensed under GNU GENERAL PUBLIC LICENSE Version 2 from June
1991 (see COPYING).


Requirements
------------

GTK+-3 development packages for *nix-like platforms. These information are only
interesting for developers, for users, certain dependencies can be retrieved
via automatic tools like rpm, apt, or such ones. The following options can be
enabled during build:

    - GConf Support
    - GTK+ Unix Print
    - Keyring Support
    - DBUS Support
    - SM client support
    - Thumbnailer
    - Previewer
    - Gtk-Doc Support
    - Debug mode
    - GObject Introspection


Installation
------------

This package should be available through your favorite software installation
tool. If you like to build it from source start by reading the chapter
'Building Xreader from source', and the file INSTALL.


Building Xreader from source
----------------------------

1) Install prerequisites:

    apt install git dpkg-dev
    apt install gobject-introspection libdjvulibre-dev libgail-3-dev          \
                libgirepository1.0-dev libgtk-3-dev libgxps-dev               \
                libkpathsea-dev libpoppler-glib-dev libsecret-1-dev           \
                libspectre-dev libwebkit2gtk-4.0-dev mate-common xsltproc     \
                yelp-tools

2) Download the source-code to your machine:

    git clone https://github.com/linuxmint/xreader.git

3) cd into the downloaded folder

    cd xreader

4) Run ./autogen.sh with options you like. The following configuration installs
   all binaries, libs, and shared files into $PWD/install, and enables all
   available options:

    ./autogen.sh                    \
        --prefix=$PWD/install/      \
        --exec-prefix=$PWD/install/ \
        --enable-debug              \
        --enable-tests              \
        --enable-pixbuf             \
        --enable-introspection      \
        --enable-gtk-doc

5) Compile and install (sudo is needed for make install)

    make && sudo make install

6) Now you can run and test (all executables are in ./install/bin):

    ./install/bin/xreader

7) You can uninstall the installed files with

    make distclean


Hacking
-------

Our Coding Guidelines can be found under
https://www.gitbook.com/book/linuxmint/coding-guidelines.


Optional Backend Libraries
--------------------------

- Poppler for PDF Backend [ http://poppler.freedesktop.org/ ]
- DjVuLibre for DjVu viewing [ http://djvulibre.djvuzone.org/ ]
- Rar for viewing CBR comics [ http://www.rarsoft.com/ ]
- libgxps for XPS documents [ https://wiki.gnome.org/libgxps ]
- GhostScript for Postscript Backend [ http://www.cs.wisc.edu/~ghost/ ]
- What about libspectre [ http://libspectre.freedesktop.org/wiki/ ]
- TIFF Backend
- DVI Backend
- Pixbuf Backend
- Comics Backend
- Impress Backend


Requirements to Run Tests
-------------------------

- python-dogtail [ https://fedorahosted.org/dogtail/ ]
- python-pyatspi2 [ http://download.gnome.org/sources/pyatspi/ ]


Optional Programs
-----------------

- Freeware unrar for viewing CBR comics [ http://www.rarsoft.com/ ]
- Gna! unrar (unrar-free) can be used too, though it can't decompress rar v3.0
  files [ http://gna.org/projects/unrar/ ]
- unzip for viewing CBZ comics [ http://www.info-zip.org ]
- p7zip for viewing CB7 comics [ http://p7zip.sourceforge.net/ ]