mirrors/zathura
1
0
Fork 0
mirror of https://git.pwmt.org/pwmt/zathura.git synced 2024-12-28 05:36:00 +01:00
Code Issues Projects Releases Packages Wiki Activity

Nicer markdown

Browse source
This commit is contained in:
Sebastian Ramacher 2020-05-28 17:51:09 +02:00
parent 1c42ec5de1
commit d5698845f5
1 changed files with 30 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -9,57 +9,57 @@ Requirements
The following dependencies are required: The following dependencies are required:
* gtk3 (>= 3.22) * `gtk3` (>= 3.22)
* glib (>= 2.50) * `glib` (>= 2.50)
* girara (>= 0.3.2) * `girara` (>= 0.3.2)
The following dependencies are optional: The following dependencies are optional:
* sqlite3 (>= 3.6.23): splite3 database backend * `sqlite3` (>= 3.6.23): splite3 database backend
* libmagic from file(1): for mime-type detection * `libmagic` from file(1): for mime-type detection
* libsynctex from TeXLive (>= 1.19): SyncTeX support * `libsynctex` from TeXLive (>= 1.19): SyncTeX support
* libseccomp: sandbox support * `libseccomp`: sandbox support
For building zathura, the following dependencies are also required: For building zathura, the following dependencies are also required:
* meson (>= 0.47) * `meson` (>= 0.47)
* gettext * `gettext`
The following dependencies are optional build-time only dependencies: The following dependencies are optional build-time only dependencies:
* check: for tests * `check`: for tests
* librvsg-bin: PNG icons * `librvsg-bin`: PNG icons
* Sphinx: manpages and HTML documentation * `Sphinx`: manpages and HTML documentation
* doxygen: HTML documentation * `doxygen`: HTML documentation
* breathe: for HTML documentation * `breathe`: for HTML documentation
* sphinx_rtd_theme: for HTML documentation * `sphinx_rtd_theme`: for HTML documentation
Note that Sphinx is needed to build the manpages. If it is not installed, the Note that `Sphinx` is needed to build the manpages. If it is not installed, the
man pages won't be built. For building the HTML documentation, doxygen, breathe man pages won't be built. For building the HTML documentation, `doxygen`,
and sphinx_rtd_theme are needed in addition to Sphinx. `breathe` and `sphinx_rtd_theme` are needed in addition to `Sphinx`.
If you don't want to build with support for sqlite databases, you can configure If you don't want to build with support for sqlite databases, you can configure
the build system with -Dsqlite=disabled and sqlite support won't be available. the build system with `-Dsqlite=disabled` and sqlite support won't be available.
The use of magic to detect mime types is optional and can be disabled by The use of magic to detect mime types is optional and can be disabled by
configuring the build system with -Dmagic=disabled. configuring the build system with `-Dmagic=disabled`.
The use of seccomp to create a sandboxed environment is optional and can be The use of `libseccomp` to create a sandboxed environment is optional and can
disabled by configure the build system with -Dseccomp=disabled. The sandbox be disabled by configure the build system with `-Dseccomp=disabled`. The
will by default be set to "normal" mode, which should not interfere with the sandbox will by default be set to "normal" mode, which should not interfere
normal operation of zathura. For strict sandbox mode set "sandbox strict" in with the normal operation of zathura. For strict sandbox mode set `sandbox
zathurarc. Strict sandbox mode will reduce the available functionality of strict` in zathurarc. Strict sandbox mode will reduce the available
zathura and provide a read only document viewer. functionality of zathura and provide a read only document viewer.
Installation Installation
------------ ------------
To build and install zathura using meson's ninja backend: To build and install zathura using meson's ninja backend:
meson build meson build
cd build cd build
ninja ninja
ninja install ninja install
Note that the default backend for meson might vary based on the platform. Please Note that the default backend for meson might vary based on the platform. Please
refer to the meson documentation for platform specific dependencies. refer to the meson documentation for platform specific dependencies.