aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorN-R-K <79544946+N-R-K@users.noreply.github.com>2021-10-02 07:29:38 +0200
committerGitHub <noreply@github.com>2021-10-02 07:29:38 +0200
commit1dc936d0eeb414a1b13ed3baa35800be3383a181 (patch)
treea64add11839e999dab0533fe9e634e2b24b3288f /README.md
parentd3a296a0be1c518cf2d073056e714385a49e8125 (diff)
downloadnsxiv-1dc936d0eeb414a1b13ed3baa35800be3383a181.tar.zst
Move over to nsxiv-extra (#100)
* change wiki links to nsxiv-extra * add User patches section * link to Project-Scope and Contribution-Guideline directly
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index 735bad3..2ffeebc 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,8 @@ nsxiv is free software licensed under GPLv2 and aims to be easy to modify and cu
Please file a bug report if something does not work as documented or
expected in *this* repository, after making sure you are using the latest
-release of nsxiv. Contributions are welcome, see [CONTRIBUTING.md](CONTRIBUTING.md)
-for details.
+release of nsxiv. Contributions are welcome, see
+[CONTRIBUTING.md](CONTRIBUTING.md#Contribution-Guideline) for details.
Features
@@ -127,18 +127,30 @@ F.A.Q
-----
* Can I open remote urls with nsxiv? <br>
-Yes, see [nsxiv-url](https://github.com/nsxiv/nsxiv/wiki/nsxiv-url)
+Yes, see [nsxiv-url](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-url)
* Can I open all the images in a directory? <br>
-Yes, see [nsxiv-rifle](https://github.com/nsxiv/nsxiv/wiki/nsxiv-rifle)
+Yes, see [nsxiv-rifle](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-rifle)
* Can I set default arguments for nsxiv? <br>
-Yes, see [nsxiv-env](https://github.com/nsxiv/nsxiv/wiki/nsxiv-env)
+Yes, see [nsxiv-env](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-env)
* Can I pipe images into nsxiv? <br>
No, not yet. See [#32](https://github.com/nsxiv/nsxiv/issues/32)
+User patches
+------------
+
+Due to our limited [project scope](CONTRIBUTING.md#Project-Scope), certain features or
+customization cannot be merged into nsxiv mainline. Following the spirit of
+suckless software, we host the [nsxiv-extra](https://github.com/nsxiv/nsxiv-extra)
+repo where users are free to submit whatever patches or scripts they wish.
+
+Description on how to use or submit patches can be found on
+[nsxiv-extra's](https://github.com/nsxiv/nsxiv-extra) README.
+
+
Download
--------