aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorN-R-K <79544946+N-R-K@users.noreply.github.com>2021-12-01 18:24:45 +0600
committerGitHub <noreply@github.com>2021-12-01 12:24:45 +0000
commit5e0b715ecd243d6556389e599d54eac2088f6890 (patch)
treea4edb25023055ecf64cc1bae33b0ed3acc837c41
parent127abbea770e1fff660b0ffd10ab58bcb46bf0af (diff)
clarify project goals (#173)
Closes: https://github.com/nsxiv/nsxiv/issues/148
-rw-r--r--CONTRIBUTING.md4
-rw-r--r--README.md5
2 files changed, 7 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4fd5ebb..a2e4477 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,6 +8,10 @@ Project Scope
* 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.
+Note: Since we aim to be a drop-in replacement for sxiv, we intend to keep all
+sxiv's behaviors/features even in cases where removing them would make the
+code-base simpler.
+
Contribution Guideline
----------------------
diff --git a/README.md b/README.md
index 5a52250..e5101cc 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,9 @@
--------------------------------------------------------------------
nsxiv is a fork of now unmaintained [sxiv](https://github.com/muennich/sxiv)
-with the purpose of maintaining it and adding simple, sensible features.
-nsxiv is free software licensed under GPLv2 and aims to be easy to modify and customize.
+with the purpose of being a drop-in replacement of sxiv, maintaining it and
+adding simple, sensible features. nsxiv is free software licensed under GPLv2
+and aims to be easy to modify and customize.
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