aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..b589908
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,10 @@
+# Notability .note support for zathura
+
+This plugin adds support for the proprietary .note format of Notability. Because I had to reverse engineer the file format, you should expect errors and many missing features.
+
+## Installation
+
+1. Install cairo, libplist, libzip and zathura (including header files obviously, e.g. using `-dev` suffix)
+2. `meson zathura-note`
+3. `cd zathura-note; sudo ninja install`
+4. Enjoy!