From 1281601f636d37ecfba473a6adf46746431237e0 Mon Sep 17 00:00:00 2001
From: Arthur Grillo <arthur.grillo@usp.br>
Date: Fri, 24 Jun 2022 11:05:15 -0300
Subject: [PATCH] Update README

This README was with wrong build steps. This commit changes to the meson
build steps and make all the text follow the mupdf plugin README
---
 README    | 22 ----------------------
 README.md | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+), 22 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index fa6e2b2..0000000
--- 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 0000000..1e64b19
--- /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.
-- 
GitLab