nsxiv1dc936d
Move over to nsxiv-extra (#100)
* change wiki links to nsxiv-extra * add User patches section * link to Project-Scope and Contribution-Guideline directly
+24 −7
2 files changed
- M CONTRIBUTING.md +7 −2
- M README.md +17 −5
| @@ -1,7 +1,8 @@ | |||
| 1 | 1 | Contribution Guideline | |
| 2 | 2 | ---------------------- | |
| 3 | 3 | ||
| 4 | − | The scope and aim of nsxiv are: | |
| 4 | + | Project Scope | |
| 5 | + | ------------- | |
| 5 | 6 | ||
| 6 | 7 | * Bug fixes and maintenance | |
| 7 | 8 | * Prioritize extensibility and simplicity | |
| @@ -9,7 +10,11 @@ The scope and aim of nsxiv are: | |||
| 9 | 10 | * Do not add extra dependency (if we do, add compile time switch to disable it) | |
| 10 | 11 | * New features may be added if it cannot be achieved (easily) via a shell script, | |
| 11 | 12 | doesn't break backwards compatibility and doesn't violate any of the above rules. | |
| 12 | − | ||
| 13 | + | ||
| 14 | + | ||
| 15 | + | Contribution Guideline | |
| 16 | + | ---------------------- | |
| 17 | + | ||
| 13 | 18 | When contributing, make sure: | |
| 14 | 19 | ||
| 15 | 20 | * Your contribution falls under nsxiv's scope and aim | |
| @@ -9,8 +9,8 @@ nsxiv is free software licensed under GPLv2 and aims to be easy to modify and cu | |||
| 9 | 9 | ||
| 10 | 10 | Please file a bug report if something does not work as documented or | |
| 11 | 11 | expected in *this* repository, after making sure you are using the latest | |
| 12 | − | release of nsxiv. Contributions are welcome, see [CONTRIBUTING.md](CONTRIBUTING.md) | |
| 13 | − | for details. | |
| 12 | + | release of nsxiv. Contributions are welcome, see | |
| 13 | + | [CONTRIBUTING.md](CONTRIBUTING.md#Contribution-Guideline) for details. | |
| 14 | 14 | ||
| 15 | 15 | ||
| 16 | 16 | Features | |
| @@ -127,18 +127,30 @@ F.A.Q | |||
| 127 | 127 | ----- | |
| 128 | 128 | ||
| 129 | 129 | * Can I open remote urls with nsxiv? <br> | |
| 130 | − | Yes, see [nsxiv-url](https://github.com/nsxiv/nsxiv/wiki/nsxiv-url) | |
| 130 | + | Yes, see [nsxiv-url](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-url) | |
| 131 | 131 | ||
| 132 | 132 | * Can I open all the images in a directory? <br> | |
| 133 | − | Yes, see [nsxiv-rifle](https://github.com/nsxiv/nsxiv/wiki/nsxiv-rifle) | |
| 133 | + | Yes, see [nsxiv-rifle](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-rifle) | |
| 134 | 134 | ||
| 135 | 135 | * Can I set default arguments for nsxiv? <br> | |
| 136 | − | Yes, see [nsxiv-env](https://github.com/nsxiv/nsxiv/wiki/nsxiv-env) | |
| 136 | + | Yes, see [nsxiv-env](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-env) | |
| 137 | 137 | ||
| 138 | 138 | * Can I pipe images into nsxiv? <br> | |
| 139 | 139 | No, not yet. See [#32](https://github.com/nsxiv/nsxiv/issues/32) | |
| 140 | 140 | ||
| 141 | 141 | ||
| 142 | + | User patches | |
| 143 | + | ------------ | |
| 144 | + | ||
| 145 | + | Due to our limited [project scope](CONTRIBUTING.md#Project-Scope), certain features or | |
| 146 | + | customization cannot be merged into nsxiv mainline. Following the spirit of | |
| 147 | + | suckless software, we host the [nsxiv-extra](https://github.com/nsxiv/nsxiv-extra) | |
| 148 | + | repo where users are free to submit whatever patches or scripts they wish. | |
| 149 | + | ||
| 150 | + | Description on how to use or submit patches can be found on | |
| 151 | + | [nsxiv-extra's](https://github.com/nsxiv/nsxiv-extra) README. | |
| 152 | + | ||
| 153 | + | ||
| 142 | 154 | Download | |
| 143 | 155 | -------- | |
| 144 | 156 | ||