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

Move over to nsxiv-extra (#100) 

* change wiki links to nsxiv-extra

* add User patches section

* link to Project-Scope and Contribution-Guideline directly
This commit is contained in:
N-R-K 2021-10-02 11:29:38 +06:00 committed by GitHub
parent d3a296a0be
commit 1dc936d0ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -1,7 +1,8 @@
Contribution Guideline Contribution Guideline
---------------------- ----------------------
The scope and aim of nsxiv are: Project Scope
-------------
* Bug fixes and maintenance * Bug fixes and maintenance
* Prioritize extensibility and simplicity * 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) * 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, * 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. doesn't break backwards compatibility and doesn't violate any of the above rules.
Contribution Guideline
----------------------
When contributing, make sure: When contributing, make sure:
* Your contribution falls under nsxiv's scope and aim * Your contribution falls under nsxiv's scope and aim

22
README.md
View File

@ -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 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 expected in *this* repository, after making sure you are using the latest
release of nsxiv. Contributions are welcome, see [CONTRIBUTING.md](CONTRIBUTING.md) release of nsxiv. Contributions are welcome, see
for details. [CONTRIBUTING.md](CONTRIBUTING.md#Contribution-Guideline) for details.
Features Features
@ -127,18 +127,30 @@ F.A.Q
----- -----
* Can I open remote urls with nsxiv? <br> * 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> * 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> * 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> * Can I pipe images into nsxiv? <br>
No, not yet. See [#32](https://github.com/nsxiv/nsxiv/issues/32) 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 Download
-------- --------