From 1dc936d0eeb414a1b13ed3baa35800be3383a181 Mon Sep 17 00:00:00 2001
From: N-R-K <79544946+N-R-K@users.noreply.github.com>
Date: Sat, 2 Oct 2021 11:29:38 +0600
Subject: Move over to nsxiv-extra (#100)
* change wiki links to nsxiv-extra
* add User patches section
* link to Project-Scope and Contribution-Guideline directly
---
CONTRIBUTING.md | 9 +++++++--
README.md | 22 +++++++++++++++++-----
2 files changed, 24 insertions(+), 7 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2f5c295..3f9ecb1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,7 +1,8 @@
Contribution Guideline
----------------------
-The scope and aim of nsxiv are:
+Project Scope
+-------------
* Bug fixes and maintenance
* Prioritize extensibility and simplicity
@@ -9,7 +10,11 @@ The scope and aim of nsxiv are:
* Do not add extra dependency (if we do, add compile time switch to disable it)
* New features may be added if it cannot be achieved (easily) via a shell script,
doesn't break backwards compatibility and doesn't violate any of the above rules.
-
+
+
+Contribution Guideline
+----------------------
+
When contributing, make sure:
* Your contribution falls under nsxiv's scope and aim
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?
-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?
-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?
-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?
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
--------
--
cgit v1.2.3