Alexander/nsxiv
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Misc docs cleanup (#362)

Browse Source 
* 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>
This commit is contained in:
NRK 2022-08-19 08:36:53 +02:00
parent 0f0c49a630
commit 32bfe58915
3 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -154,10 +154,14 @@ the following command:
Usage Usage
----- -----
Refer to the man page for the documentation: Refer to the man-page for the documentation:
$ man nsxiv $ 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. F.A.Q.
------ ------
@ -218,9 +222,9 @@ viewers to try out.
Below are a couple other lesser known projects not listed in suckless rocks. 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. 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. Minimal and extensive, aimed at C devs willing to build their own features.
* [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer): * [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer):
Lua script to turn mpv into an image viewer. Supports thumbnails via Lua script to turn mpv into an image viewer. Supports thumbnails via

12
etc/CHANGELOG.md
View File

@ -129,13 +129,13 @@ references *above* can be found on the new main nsxiv repository on CodeBerg.
performance in `config.h`. [#171] performance in `config.h`. [#171]
* Cli flag `-0` for sending null-seperated file-list to standard out (`-o`), * 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`). 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] * Export environment variable `NSXIV_USING_NULL` to key-handler. [#164]
* Embed new nsxiv icon. [#163] * Embed new nsxiv icon. [#163]
* `make install-icon` to install icons. [#80] [#96] * `make install-icon` to install icons. [#80],[#96]
* `make install-desktop` to install .desktop entry. [#80] [#96] * `make install-desktop` to install .desktop entry. [#80],[#96]
* `make install-all` to install everything. [#80] [#96] * `make install-all` to install everything. [#80],[#96]
* Configurable `KEYHANDLER_ABORT` in `config.h`. [#91] [#172] * Configurable `KEYHANDLER_ABORT` in `config.h`. [#91],[#172]
* Statusbar message upon key-handler activation. [#98] * Statusbar message upon key-handler activation. [#98]
* Ability to write custom C functions in `config.h` and use them via * Ability to write custom C functions in `config.h` and use them via
keybindings. [#76] 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] * Removed non-POSIX commands and extensions from `Makefile`. [#71]
* Regression where nsxiv wouldn't run on non-TrueColor X server. [#114] * Regression where nsxiv wouldn't run on non-TrueColor X server. [#114]
* Wrong comments in `config.h` and description in `manpage`. * Wrong comments in `config.h` and description in `manpage`.
[#105] [#106] [#152] [#105],[#106],[#152]
[#20]: https://codeberg.org/nsxiv/nsxiv-record/pulls/20 [#20]: https://codeberg.org/nsxiv/nsxiv-record/pulls/20
[#68]: https://codeberg.org/nsxiv/nsxiv-record/pulls/68 [#68]: https://codeberg.org/nsxiv/nsxiv-record/pulls/68

2
etc/nsxiv.1
View File

@ -526,7 +526,7 @@ Bert Muennich <ber.t at posteo.de>
.EE .EE
.SH CURRENT MAINTAINERS .SH CURRENT MAINTAINERS
.EX .EX
N-R-K <nrk at disroot.org> NRK <nrk at disroot.org>
Berke Kocaoğlu <berke.kocaoglu at metu.edu.tr> Berke Kocaoğlu <berke.kocaoglu at metu.edu.tr>
TAAPArthur <taaparthur at gmail.com> TAAPArthur <taaparthur at gmail.com>
eylles <ed.ylles1997 at gmail.com> eylles <ed.ylles1997 at gmail.com>