nsxiv68ddbe2
Reference customization in readme (#175)
* Document customization more thoroughly * sneak a small doc change in at the request of explosion-mental: https://github.com/nsxiv/nsxiv/pull/170#issuecomment-979600811
+16 −7
1 file changed
- M README.md +16 −7
| @@ -161,16 +161,25 @@ Yes, see [nsxiv-env](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/ns | |||
| 161 | 161 | Yes, see [nsxiv-pipe](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-pipe) | |
| 162 | 162 | ||
| 163 | 163 | ||
| 164 | − | User patches | |
| 165 | − | ------------ | |
| 164 | + | Customization | |
| 165 | + | ------------- | |
| 166 | + | ||
| 167 | + | The main method of customizing nsxiv is by setting values for the variables in *config.h*, | |
| 168 | + | or by using Xresources as explained in the manual. If these options are not sufficient, | |
| 169 | + | you may implement your own features by following | |
| 170 | + | [this guide](https://github.com/nsxiv/nsxiv-extra/blob/master/CUSTOMIZATION.md). | |
| 166 | 171 | ||
| 167 | 172 | Due to our limited [project scope](CONTRIBUTING.md#Project-Scope), certain features or | |
| 168 | − | customization cannot be merged into nsxiv mainline. Following the spirit of | |
| 169 | − | suckless software, we host the [nsxiv-extra](https://github.com/nsxiv/nsxiv-extra) | |
| 170 | − | repo where users are free to submit whatever patches or scripts they wish. | |
| 173 | + | customization cannot be merged into nsxiv mainline. Following the spirit of suckless | |
| 174 | + | software, we host the [nsxiv-extra](https://github.com/nsxiv/nsxiv-extra) repo where users | |
| 175 | + | are free to submit whatever patches or scripts they wish. | |
| 176 | + | ||
| 177 | + | If you think your custom features can be beneficial for the general user base and is within | |
| 178 | + | our project scope, please submit it as a pull request on this repository, then we *may* | |
| 179 | + | merge it to mainline. | |
| 171 | 180 | ||
| 172 | 181 | Description on how to use or submit patches can be found on | |
| 173 | − | [nsxiv-extra's](https://github.com/nsxiv/nsxiv-extra) README. | |
| 182 | + | nsxiv-extra's [README](https://github.com/nsxiv/nsxiv-extra). | |
| 174 | 183 | ||
| 175 | 184 | ||
| 176 | 185 | Download | |
| @@ -193,7 +202,7 @@ to try out. | |||
| 193 | 202 | Below are a couple other lesser known projects not listed in suckless rocks. | |
| 194 | 203 | ||
| 195 | 204 | * [MAGE](https://github.com/explosion-mental/mage) : | |
| 196 | − | Aims to be a smaller/more-suckless version of sxiv. | |
| 205 | + | A smaller/more-suckless version of sxiv. | |
| 197 | 206 | * [div](https://github.com/TAAPArthur/div) : | |
| 198 | 207 | Minimal and extensive, aimed at C devs willing to build their own features. | |
| 199 | 208 | * [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer) : | |