diff --git a/README b/README deleted file mode 100644 index fa6e2b23d72cdb7832746241a9b90ba8c63291ed..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,22 +0,0 @@ -zathura-pdf-poppler -=================== -The zathura-pdf-poppler plugin adds PDF support to zathura by using the poppler -rendering library. - -Requirements ------------- -zathura (>= 0.4.4) -girara -poppler-glib (>= 0.18) - -Installation ------------- -To build and install the plugin: - - make install - -Uninstall: ----------- -To delete the plugin from your system, just type: - - make uninstall diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..1e64b1962eb62edc0f64558e2ab4bf8fad3cf45c --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +zathura-pdf-poppler +=================== + +zathura is a highly customizable and functional document viewer based on the girara user interface +library and several document libraries. This plugin for zathura provides PDF support using the +`poppler` rendering library. + +Requirements +------------ + +The following dependencies are required: + +* `zathura` (>= 0.4.4) +* `girara` +* `poppler-glib` (>= 0.18) + +Installation +------------ + +To build and install the plugin using meson's ninja backend: + + meson build + cd build + ninja + ninja install + +Note that the default backend for meson might vary based on the platform. Please +refer to the meson documentation for platform specific dependencies. + +Bugs +---- + +Please report bugs at http://git.pwmt.org/pwmt/zathura-pdf-poppler.