Commit Graph

140 Commits

Author SHA1 Message Date
ef18af438d
update README to current state 2024-03-10 12:06:30 +01:00
NRK
ac1199b6f5 README: update upstream sxiv link 2023-01-28 16:29:36 +06:00
NRK
75849adb88 README: fix rendering on codeberg (#402)
looks like some update to the markdown parser at codeberg broke our readme.
just use a simple `*` instead (escaped by `\` to be safe)

Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/402
2023-01-12 09:38:14 +00:00
NRK
32bfe58915 Misc docs cleanup (#362)
* 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-19 08:36:53 +02:00
NRK
fb9686c650 Move uncritical files into etc/ (#350)
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-09 16:21:52 +02:00
Nan
3e17e4684c README: fix broken link (#351)
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-08-02 12:54:33 +02:00
Berke Kocaoğlu
5c2c719735 Clean up readme (#330)
Co-authored-by: NRK <nrk@disroot.org>
Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/330
Reviewed-by: NRK <nrk@disroot.org>
2022-06-29 01:02:17 +02:00
Sanjay Pavan
91e097a4e6 Fix links in readme (#309)
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-12 18:49:49 +02:00
NRK
4c6d26bef4 Move over to codeberg (#293)
Reviewed-by: Berke Kocaoğlu <berke.kocaoglu@metu.edu.tr>
2022-06-11 15:38:07 +02:00
eylles
09d2d738ad
adds emblems of mirrors 2022-06-06 18:56:21 -06:00
NRK
197afce935 introduce config.mk
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-05-30 12:07:01 +00:00
N-R-K
5bb1df4af3
README: some wording change and cosmetics (#269) 2022-04-28 01:11:27 +00:00
Berke Kocaoğlu
7f71ddf4fc
Export known issues in readme to GitHub issues (#243)
Export known issues in readme to GitHub issues and link the issue
2022-03-08 10:23:35 +03:00
Berke Kocaoğlu
9f12c79d1b
Add libXft-bgra to FAQ in readme (#229)
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>
2022-02-25 01:36:58 +03:00
Sanjay Pavan
494578cebb
README: Fix version badge (#185) 2021-12-12 12:14:33 +00:00
NRK
eccd7de532 remove unneeded animated-webp hacks
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-12 17:58:17 +06:00
N-R-K
5e0b715ecd
clarify project goals (#173)
Closes: https://github.com/nsxiv/nsxiv/issues/148
2021-12-01 12:24:45 +00:00
Berke Kocaoğlu
68ddbe28d8
Reference customization in readme (#175)
* 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-26 14:38:00 +00:00
N-R-K
7d87e6e412
add related projects and some doc fixes (#170)
* 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-23 07:27:14 +00:00
Sanjay Pavan
a841d1c8de
Adding shields.io badges for Readme (#159)
* 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-06 02:02:02 -06:00
mamg22
22a6911484
Update FAQ regarding piping images (#158) 2021-11-05 07:17:08 +03:00
N-R-K
804a0f4304
README: add package manager section (#111)
Closes: https://github.com/nsxiv/nsxiv/issues/72
2021-10-19 13:00:23 +00:00
Arthur Williams
675db4bbb6 Make statusbar optional (#95)
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-10 02:17:50 +06:00
N-R-K
e8d08ba67e
Rework build system v2 (#71)
* 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-03 16:52:12 +00:00
N-R-K
1dc936d0ee
Move over to nsxiv-extra (#100)
* change wiki links to nsxiv-extra

* add User patches section

* link to Project-Scope and Contribution-Guideline directly
2021-10-01 23:29:38 -06:00
Berke Kocaoğlu
696f68753f
Rename icon & desktop and add install-all in Makefile (#96)
* 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-25 05:00:21 +00:00
Sam Whitehead
af98249b68 Add animated webp support (#20)
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-24 17:27:22 +06:00
Berke Kocaoğlu
0e7ab7e5c3
Fix consistency in readme (#93) 2021-09-24 05:07:27 +00:00
Guilherme Rugai Freire
de9a285ff2
Add desktop and icon rules to Makefile, document icon installation (#80)
Co-authored-by: NRK <nrk@disroot.org>
2021-09-23 02:17:52 +00:00
Berke Kocaoğlu
9e22f32c07
Change location of example scripts (#86)
* Use DOCPREFIX similar to MANPREFIX

Co-authored-by: NRK <nrk@disroot.org>
2021-09-22 18:36:55 +00:00
NRK
9c3310b676 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.
2021-09-21 17:50:23 +03:00
Berke Kocaoğlu
3ef355bccc Fix links in changelog and readme 2021-09-17 00:39:40 +03:00
NRK
956faac00c cleanup docs 2021-09-17 02:28:18 +06:00
Berke Kocaoğlu
7cce7ea857 Rename, Update Docs and Prepare for Release (#9)
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-16 22:55:31 +03:00
TAAPArthur
25a3114709 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>
2021-09-16 22:55:31 +03:00
Bert Münnich
1d28627868 Stable version 26 2020-01-16 14:30:49 +01:00
Bert Münnich
8494b43635 Document dependencies
Fixes issues #378 and #374.
2020-01-16 12:36:26 +01:00
Bert Münnich
f88afbb277 Stable version 25 2019-01-26 14:54:40 +01:00
Bert Münnich
174e2dd94c Overhaul introductionary text 2019-01-26 14:11:21 +01:00
Bert Münnich
9dabc5f988 Stable version 24 2017-10-27 17:25:56 +02:00
Bert Münnich
c280129cef Use Xft for font loading and text drawing 2016-08-06 15:27:58 +02:00
Bert Münnich
f32771a647 Removed usage information from README, refer to man page 2016-02-12 20:18:54 +01:00
Bert Münnich
f75fa78eca Make navigate_frame command respect a count prefix 2015-12-26 15:24:08 +01:00
Bert Münnich
93e2d03c73 Stable version 1.3.2 2015-12-20 13:21:25 +01:00
Bert Münnich
808a10ed04 Updated documentation regarding gamma correction 2015-01-07 08:43:54 +01:00
Bert Münnich
1439b84544 Stable version 1.3.1 2014-11-16 21:38:30 +01:00
Bert Münnich
c038283286 Stable version 1.3 2014-10-24 12:25:18 +02:00
Bert Münnich
7b91e10f22 Added thumbnail zooming...
- Key mappings +/- are now general commands
- Use JPG as thumbnail cache file format instead of PNG
- Fixes issue #161
2014-09-28 00:28:50 +02:00
Bert Münnich
1094def183 Added command to remove all image marks, bound to Ctrl-m; fixes issue #163 2014-08-17 20:27:01 +02:00
Bert Münnich
5e481912ec Revised handling of GIF animations
- New option `-a`: Play animations at startup
- Ctrl-Space toggles animation for all GIF files
- Infinite loop for all animations
2014-07-25 22:52:31 +02:00