summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTAAPArthur <taaparthur@gmail.com>2021-09-14 16:42:57 +0200
committerBerke Kocaoğlu <berke.kocaoglu@metu.edu.tr>2021-09-16 21:55:31 +0200
commit25a31147093e249be997da9b42da6901496fdf52 (patch)
tree6cb2a3cf0973ce4a1a5d3f23c8331911b7bf2b3a /README.md
parentcca7834e6718c6ff64da42ed5e9770880a3e8ff6 (diff)
downloadnsxiv-25a31147093e249be997da9b42da6901496fdf52.tar.zst
Rework the build system (#19)
* Added simple configure script Added simple script to autodetect if optional dependencies are installed and enable/disable them as needed. Note this solution uses the compiler directly instead of an external program like pkgconfig so it doesn't require any extra dependencies. It is intended to work with any arbitrary compiler; it has been tested with tcc and gcc. There are some "breaking" changes hidden here - HAVE_GIFLIB was renamed to HAVE_LIBGIF to match HAVE_LIBEXIF - Simply typing `make` will no longer try to build with optional dependencies * use implicit RM variable * General clean-up in configure - Use printf instead of echo - Format style * honor env PREFIX, use LDLIBS * Revert "General clean-up in configure" This reverts commit 8683c179dbf273a330f9a224a4d481a7bea42c5f. * honor env LDFLAGS if set * Don't set OPTIONAL_LIBS in configure * make OBJ all caps * follow suckless style build system - remove configure script. - HAVE_LIBGIF and HAVE_LIBEXIF defaults back to 1 - unload several varibales onto config.mk - make version all-caps - add -O2 optimization - use CPPFLAGS for includes and defines * Revert "follow suckless style build system" This reverts commit 8bf75b1f68d72df349edba8d998d4659dd956dd8. * Generate config.mk from make * Inlined configure in Makefile * update docs * cleanups - changes to config.mk should trigger a rebuild - remove potentially confusing variables form Makefile * Use install instead of mkdir/cp/chmod when sensible * fixup! Inlined configure in Makefile * Don't generate config.mk on rm -f *.o sxiv * update docs and cleanups - make config.mk silent - mention editing config.mk in README * fallback to 0 if user edits config.mk in unexpected way * add comment on config.mk * remove invalid comment configure script is removed * slight restructure - make version all caps - restructure variables that users may want to edit to top - use CPPFLAGS for defines - add some comments - remove needless echos since we have verbose output now * add echos back Co-authored-by: NRK <nrk@disroot.org> Co-authored-by: Berke Kocaoğlu <berke.kocaoglu@metu.edu.tr>
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 8795fb5..f2aba7a 100644
--- a/README.md
+++ b/README.md
@@ -42,8 +42,8 @@ sxiv requires the following software to be installed:
* Xft
* freetype2
* fontconfig
- * giflib (optional, disabled with `HAVE_GIFLIB=0`)
- * libexif (optional, disabled with `HAVE_LIBEXIF=0`)
+ * giflib (optional, automatically enabled if installed)
+ * libexif (optional, automatically enabled if installed)
Please make sure to install the corresponding development packages in case that
you want to build sxiv on a distribution with separate runtime and development
@@ -62,6 +62,15 @@ Please note, that the latter one requires root privileges.
By default, sxiv is installed using the prefix "/usr/local", so the full path
of the executable will be "/usr/local/bin/sxiv".
+Running make will automatically detect if libexif and libgif are available and
+enable them if so. CLI arguments will override any automatic detection.
+For example:
+
+ $ make HAVE_LIBGIF=0
+
+will always disable libgif.
+Alternatively, they can be disabled via editing `config.mk`.
+
You can install sxiv into a directory of your choice by changing the second
command to: