aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
AgeCommit message (Collapse)Author
2022-08-19Misc docs cleanup (#362)NRK
* link to online man-page * rename: "N-R-K" -> "NRK" * separate multiple links with a comma. otherwise the links get messed up due to `[] []` being valid syntax for reference style links with the 2nd `[]` serving as `id`. * prefer codeberg links over github ones Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/362 Reviewed-by: explosion-mental <explosion-mental@noreply.codeberg.org>
2022-08-09Move uncritical files into `etc/` (#350)NRK
This is mainly just to reduce the amount of files in the project root. The criteria of what gets into `etc/` are the following: * The file should not be necessary for building nsxiv. This excludes the `icon/*` stuff since that's needed by `window.c`. * The file shouldn't have any valid reason to stay in the project root. This excludes things like `README.md`, `.gitignore` etc. Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/350 Reviewed-by: explosion-mental <explosion-mental@noreply.codeberg.org>
2022-08-02README: fix broken link (#351)Nan
Fixes a link that previously 404'd Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/351 Reviewed-by: NRK <nrk@disroot.org> Co-authored-by: Nan <nan42@waifu.club> Co-committed-by: Nan <nan42@waifu.club>
2022-06-29Clean up readme (#330)Berke Kocaoğlu
Co-authored-by: NRK <nrk@disroot.org> Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/330 Reviewed-by: NRK <nrk@disroot.org>
2022-06-12Fix links in readme (#309)Sanjay Pavan
The former worked on GitHub, but does not work on Codeberg. Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/309 Reviewed-by: Berke Kocaoğlu <berke.kocaoglu@metu.edu.tr> Co-authored-by: Sanjay Pavan <withercubes@protonmail.com> Co-committed-by: Sanjay Pavan <withercubes@protonmail.com>
2022-06-11Move over to codeberg (#293)NRK
Reviewed-by: Berke Kocaoğlu <berke.kocaoglu@metu.edu.tr>
2022-06-07adds emblems of mirrorseylles
2022-05-30introduce config.mkNRK
this moves all the build variables intended to be modified by the user over to `config.mk` similar to other suckless software. also move CPPFLAGS down below for cosmetic purposes.
2022-04-28README: some wording change and cosmetics (#269)N-R-K
2022-03-08Export known issues in readme to GitHub issues (#243)Berke Kocaoğlu
Export known issues in readme to GitHub issues and link the issue
2022-02-24Add libXft-bgra to FAQ in readme (#229)Berke Kocaoğlu
Co-authored-by: NRK <nrk@disroot.org> Co-authored-by: eylles <ed.ylles1997@gmail.com> Co-authored-by: explosion-mental <explosion0mental@gmail.com> Co-authored-by: mamg22 <marcomonizg@gmail.com>
2021-12-12README: Fix version badge (#185)Sanjay Pavan
2021-12-12remove unneeded animated-webp hacksNRK
now that imlib2 (v1.7.5) is able to load the first frame of an animated-webp file, we no longer need the `is_webp` check to bypass imlib2. ref: https://phab.enlightenment.org/T8964
2021-12-01clarify project goals (#173)N-R-K
Closes: https://github.com/nsxiv/nsxiv/issues/148
2021-11-26Reference customization in readme (#175)Berke Kocaoğlu
* Document customization more thoroughly * sneak a small doc change in at the request of explosion-mental: https://github.com/nsxiv/nsxiv/pull/170#issuecomment-979600811 Co-authored-by: NRK <nrk@disroot.org>
2021-11-23add related projects and some doc fixes (#170)N-R-K
* README: add related projects Closes: https://github.com/nsxiv/nsxiv/issues/169 * fix readme feature section correct animations part (we support webp animation as well) and mention key-handler * remove duplicate Contribution Guideline heading
2021-11-06Adding shields.io badges for Readme (#159)Sanjay Pavan
* shields.io badges for Readme * Changed up the colors a little bit * Once again a color change * Changed badge from code size to total lines
2021-11-05Update FAQ regarding piping images (#158)mamg22
2021-10-19README: add package manager section (#111)N-R-K
Closes: https://github.com/nsxiv/nsxiv/issues/72
2021-10-09Make statusbar optional (#95)Arthur Williams
libXft and libfontconfig are now optional dependencies which can be disabled via `HAVE_LIBFONTS=0`. Disabling them means disabling the statusbar. This also does not search for freetype2 header if disabled. Co-authored-by: NRK <nrk@disroot.org>
2021-10-03Rework build system v2 (#71)N-R-K
* Remove non-POSIX extensions and commands * Drop autodetection in favor of OPT_DEP_DEFAULT * Use += for LDLIBS as some BSD distros need to add extra flags * Change DOCPREFIX -> EGPREFIX * Use ?= for MANPREFIX and EGPREFIX * Update docs With this, we should have a stable build system. No further significant changes should be needed.
2021-10-02Move over to nsxiv-extra (#100)N-R-K
* change wiki links to nsxiv-extra * add User patches section * link to Project-Scope and Contribution-Guideline directly
2021-09-25Rename icon & desktop and add install-all in Makefile (#96)Berke Kocaoğlu
* Rename in Makefile Renamed {icon,desktop} => install-{icon,desktop} * Add install-all in Makefile * Added .PHONY targets and renamed icon_cleanup Added .PHONY targets and renamed icon_cleanup to uninstall_icon * Update README.md Co-authored-by: TAAPArthur <taaparthur@gmail.com>
2021-09-24Add animated webp support (#20)Sam Whitehead
Co-authored-by: NRK <nrk@disroot.org> Co-authored-by: Stein Gunnar Bakkeby <bakkeby@gmail.com> Co-authored-by: Berke Kocaoğlu <berke.kocaoglu@metu.edu.tr>
2021-09-24Fix consistency in readme (#93)Berke Kocaoğlu
2021-09-23Add desktop and icon rules to Makefile, document icon installation (#80)Guilherme Rugai Freire
Co-authored-by: NRK <nrk@disroot.org>
2021-09-22Change location of example scripts (#86)Berke Kocaoğlu
* Use DOCPREFIX similar to MANPREFIX Co-authored-by: NRK <nrk@disroot.org>
2021-09-21better document what the optional deps doNRK
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.
2021-09-16Fix links in changelog and readmeBerke Kocaoğlu
2021-09-16cleanup docsNRK
2021-09-16Rename, Update Docs and Prepare for Release (#9)Berke Kocaoğlu
Co-authored-by: Guilherme Rugai Freire <41879254+GRFreire@users.noreply.github.com> Co-authored-by: N-R-K <79544946+N-R-K@users.noreply.github.com> Co-authored-by: NRK <nrk@disroot.org> Co-authored-by: Arthur Williams <taaparthur@gmail.com> Co-authored-by: eylles <ed.ylles1997@gmail.com>
2021-09-16Rework the build system (#19)TAAPArthur
* 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>
2020-01-16Stable version 26v26Bert Münnich
2020-01-16Document dependenciesBert Münnich
Fixes issues #378 and #374.
2019-01-26Stable version 25v25Bert Münnich
2019-01-26Overhaul introductionary textBert Münnich
2017-10-27Stable version 24v24Bert Münnich
2016-08-06Use Xft for font loading and text drawingBert Münnich
2016-02-12Removed usage information from README, refer to man pageBert Münnich
2015-12-26Make navigate_frame command respect a count prefixBert Münnich
2015-12-20Stable version 1.3.2v1.3.2Bert Münnich
2015-01-07Updated documentation regarding gamma correctionBert Münnich
2014-11-16Stable version 1.3.1v1.3.1Bert Münnich
2014-10-24Stable version 1.3v1.3Bert Münnich
2014-09-28Added thumbnail zooming...Bert Münnich
- Key mappings +/- are now general commands - Use JPG as thumbnail cache file format instead of PNG - Fixes issue #161
2014-08-17Added command to remove all image marks, bound to Ctrl-m; fixes issue #163Bert Münnich
2014-07-25Revised handling of GIF animationsBert Münnich
- New option `-a`: Play animations at startup - Ctrl-Space toggles animation for all GIF files - Infinite loop for all animations
2014-07-23Revised command structure and key and mouse button mappingsBert Münnich
2014-06-09Use thumbnails in EXIF tags; requirement for libexif is backBert Münnich
2014-04-24Stable version 1.2v1.2Bert Münnich