From 32bfe589156ed31fffc19b34189ba4a63e108566 Mon Sep 17 00:00:00 2001 From: NRK Date: Fri, 19 Aug 2022 08:36:53 +0200 Subject: [PATCH] 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 --- README.md | 10 +++++++--- etc/CHANGELOG.md | 12 ++++++------ etc/nsxiv.1 | 2 +- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index bcefea8..9111193 100644 --- a/README.md +++ b/README.md @@ -154,10 +154,14 @@ the following command: Usage ----- -Refer to the man page for the documentation: +Refer to the man-page for the documentation: $ man nsxiv +You may also view the man-page [online](https://nsxiv.codeberg.page/man/). +However, note that the online man-page might not accurately represent your local +copy. + F.A.Q. ------ @@ -218,9 +222,9 @@ viewers to try out. Below are a couple other lesser known projects not listed in suckless rocks. -* [MAGE](https://github.com/explosion-mental/mage): +* [MAGE](https://codeberg.org/explosion-mental/mage): A smaller/more-suckless version of sxiv. -* [div](https://github.com/TAAPArthur/div): +* [div](https://codeberg.org/TAAPArthur/div): Minimal and extensive, aimed at C devs willing to build their own features. * [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer): Lua script to turn mpv into an image viewer. Supports thumbnails via diff --git a/etc/CHANGELOG.md b/etc/CHANGELOG.md index 100e24a..ce62edf 100644 --- a/etc/CHANGELOG.md +++ b/etc/CHANGELOG.md @@ -129,13 +129,13 @@ references *above* can be found on the new main nsxiv repository on CodeBerg. performance in `config.h`. [#171] * Cli flag `-0` for sending null-seperated file-list to standard out (`-o`), and key-handler and receiving null-seperated file-list via stdin (`-i`). - [#68] [#141] [#164] + [#68],[#141],[#164] * Export environment variable `NSXIV_USING_NULL` to key-handler. [#164] * Embed new nsxiv icon. [#163] - * `make install-icon` to install icons. [#80] [#96] - * `make install-desktop` to install .desktop entry. [#80] [#96] - * `make install-all` to install everything. [#80] [#96] - * Configurable `KEYHANDLER_ABORT` in `config.h`. [#91] [#172] + * `make install-icon` to install icons. [#80],[#96] + * `make install-desktop` to install .desktop entry. [#80],[#96] + * `make install-all` to install everything. [#80],[#96] + * Configurable `KEYHANDLER_ABORT` in `config.h`. [#91],[#172] * Statusbar message upon key-handler activation. [#98] * Ability to write custom C functions in `config.h` and use them via keybindings. [#76] @@ -151,7 +151,7 @@ references *above* can be found on the new main nsxiv repository on CodeBerg. * Removed non-POSIX commands and extensions from `Makefile`. [#71] * Regression where nsxiv wouldn't run on non-TrueColor X server. [#114] * Wrong comments in `config.h` and description in `manpage`. - [#105] [#106] [#152] + [#105],[#106],[#152] [#20]: https://codeberg.org/nsxiv/nsxiv-record/pulls/20 [#68]: https://codeberg.org/nsxiv/nsxiv-record/pulls/68 diff --git a/etc/nsxiv.1 b/etc/nsxiv.1 index 29f036f..3155958 100644 --- a/etc/nsxiv.1 +++ b/etc/nsxiv.1 @@ -526,7 +526,7 @@ Bert Muennich .EE .SH CURRENT MAINTAINERS .EX -N-R-K +NRK Berke Kocaoğlu TAAPArthur eylles