aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNRK <nrk@disroot.org>2021-09-21 12:24:28 +0600
committerBerke Kocaoğlu <berke.kocaoglu@metu.edu.tr>2021-09-21 17:50:23 +0300
commit9c3310b6761513e9454f293bd6cfcc6cf7f54921 (patch)
tree8b581597f5eab4277eab983596e9a5bc5e48a8a4 /README.md
parent63972db743398a4c2f0159110f5e14fb1effb6d5 (diff)
better document what the optional deps do
currently the README only mentions what deps are optional but has no info on what they do. we had an issue where a user was confused about what libexif is used for : https://github.com/nsxiv/nsxiv/issues/58 this makes it clear what each of the optional deps do so that users can make more informed decision on weather they want something or not.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 747dc7c..2799bf1 100644
--- a/README.md
+++ b/README.md
@@ -48,8 +48,11 @@ nsxiv requires the following software to be installed:
* Xft
* freetype2
* fontconfig
- * giflib (optional, automatically enabled if installed)
- * libexif (optional, automatically enabled if installed)
+
+The following libraries are optional. They are automatically enabled if installed.
+
+ * giflib : Used for animated gif playback.
+ * libexif : Used for auto-orientation and exif thumbnails.
Please make sure to install the corresponding development packages in case that
you want to build nsxiv on a distribution with separate runtime and development