Krolyxon
Commit 4c6d26b

Branches

Refs →

nsxiv4c6d26b

Move over to codeberg (#293)

Author
NRK
Date
2022-06-11 15:38 +0200
Parent
09d2d73
Commit
4c6d26bef4d5e7ca9554a485751ea7306ae4b9d0

+68 −31

4 files changed

  1. A .github/workflows/lock.yml +21 −0
  2. M CONTRIBUTING.md +26 −6
  3. M README.md +19 −23
  4. M nsxiv.1 +2 −2
A .github/workflows/lock.yml View
@@ -0,0 +1,21 @@
1+name: 'Repo Lockdown'
2+
3+on:
4+ pull_request_target:
5+ types: opened
6+
7+permissions:
8+ pull-requests: write
9+
10+jobs:
11+ action:
12+ runs-on: ubuntu-latest
13+ steps:
14+ - uses: dessant/repo-lockdown@v2
15+ with:
16+ pr-comment: >
17+ Hi, thanks for the Pull-Request.
18+ However this repository is a read-only mirror, main development of nsxiv happens over at [CodeBerg](https://codeberg.org/nsxiv/nsxiv).
19+ Please open your Pull-Request over on the CodeBerg Repo.
20+ Otherwise you may also e-mail the patch (obtained via `git format-patch`) to any of the [active maintainers](https://nsxiv.codeberg.page/man/#CURRENT%20MAINTAINERS) instead.
21+
M CONTRIBUTING.md View
@@ -12,6 +12,10 @@ Note: Since we aim to be a drop-in replacement for sxiv, we intend to keep all
1212 sxiv's behaviors/features even in cases where removing them would make the
1313 code-base simpler.
1414
15+Also note that (n)sxiv uses `imlib2` for loading images. Thus any request or
16+patches for adding support for new image formats should go into
17+[imlib2's repo](https://git.enlightenment.org/old/legacy-imlib2) instead.
18+
1519
1620 Contribution Guideline
1721 ----------------------
@@ -28,17 +32,18 @@ If your contribution is not suitable for general use, it will not be included in
2832 For changes that are very much up to preference, such as changing values in config.h,
2933 please do not open a pull request unless you have an objective explanation.
3034
31−See the [open issues](https://github.com/nsxiv/nsxiv/issues) to find something
35+See the [open issues](https://codeberg.org/nsxiv/nsxiv/issues) to find something
3236 to work on. You can also filter the issues via label:
3337
34−* [Good first issue](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22):
38+* [Good first issue](https://codeberg.org/nsxiv/nsxiv/issues?labels=49698):
3539 (Easy) Issues which do not require much if any experience.
36−* [Up for grabs](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22):
40+* [Up for grabs](https://codeberg.org/nsxiv/nsxiv/issues?labels=49705):
3741 (Intermediate) Issues which are free for anyone who wants to pick it up.
3842 Might require some experience.
39−* [Help wanted](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22):
43+* [Help wanted](https://codeberg.org/nsxiv/nsxiv/issues?labels=49699):
4044 (Intermediate/Experienced) Issues where we require some help.
4145
46+
4247 Development workflow for maintainers
4348 ------------------------------------
4449
@@ -69,6 +74,21 @@ For releases, the process is the following:
6974 release, the "Added" section for new features, and the "Fixes" section
7075 for fixed bugs or regressions. Include pull request IDs.
7176
77+Mirroring to GitHub:
78+
79+Assuming `origin` is the name of the codeberg remote and `github` is the name
80+of the github remote; run the following commands to mirror the codeberg repo to
81+github:
82+
83+```console
84+$ git fetch --prune origin
85+$ git push --prune github '+refs/remotes/origin/*:refs/heads/*' '+refs/tags/*:refs/tags/*'
86+```
87+
88+The first command updates the local repo and the second command pushes
89+everything on `origin` without pushing any of the local branches.
90+
91+- - -
92+
7293 For mundane development related talks which don't warrant their own issue, use
73−the [general-dev](https://github.com/nsxiv/nsxiv/discussions/119) discussion
74−thread.
94+the [general discussion](https://codeberg.org/nsxiv/nsxiv/issues/294) thread.
M README.md View
@@ -1,13 +1,9 @@
1−[![nsxiv](https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/logo.png)](https://github.com/nsxiv/nsxiv)
1+[![nsxiv](https://codeberg.org/nsxiv/pages/raw/branch/master/img/logo.png)](https://codeberg.org/nsxiv/nsxiv)
22
3−[![tags](https://img.shields.io/github/v/tag/nsxiv/nsxiv?style=flat-square)](https://github.com/nsxiv/nsxiv/tags)
4−[![license](https://img.shields.io/badge/license-GPL--2.0-lightgreen?style=flat-square)](https://github.com/nsxiv/nsxiv/blob/master/LICENSE)
5−[![loc](https://img.shields.io/tokei/lines/github/nsxiv/nsxiv?color=red&style=flat-square)](https://github.com/nsxiv/nsxiv)
6−
7−<p align="center">
8−<a href="https://github.com/nsxiv/nsxiv" alt="GitHub"><img src="https://img.shields.io/badge/Github-2B3137?style=for-the-badge&logo=Github&logoColor=FFFFFF"></a>
9−<a href="https://codeberg.org/nsxiv/nsxiv" alt="CodeBerg"><img src="https://img.shields.io/badge/Codeberg-2185D0?style=for-the-badge&logo=codeberg&logoColor=F2F8FC"></a>
10−</p>
3+[![CodeBerg](https://img.shields.io/badge/Hosted_at-Codeberg-%232185D0?style=flat-square&logo=CodeBerg)](https://codeberg.org/nsxiv/nsxiv)
4+[![tags](https://img.shields.io/github/v/tag/nsxiv/nsxiv?style=flat-square)](https://codeberg.org/nsxiv/nsxiv/tags)
5+[![license](https://img.shields.io/badge/license-GPL--2.0-lightgreen?style=flat-square)](https://codeberg.org/nsxiv/nsxiv/src/branch/master/LICENSE)
6+[![loc](https://img.shields.io/tokei/lines/github/nsxiv/nsxiv?color=red&style=flat-square)](https://codeberg.org/nsxiv/nsxiv)
117
128 **Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer**
139 --------------------------------------------------------------------
@@ -41,18 +37,18 @@ Screenshots
4137
4238 **Image mode: (Default colors)**
4339
44−![Image](https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/image.png "Image mode")
40+![Image](https://codeberg.org/nsxiv/pages/raw/branch/master/img/image.png "Image mode")
4541
4642 **Thumbnail mode: (Custom colors)**
4743
48−![Thumb](https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/thumb.png "Thumb mode")
44+![Thumb](https://codeberg.org/nsxiv/pages/raw/branch/master/img/thumb.png "Thumb mode")
4945
5046
5147 Installing via package manager
5248 ------------------------------
5349
5450 <a href="https://repology.org/project/nsxiv/versions">
55− <img align="right" width="192" src="https://repology.org/badge/vertical-allrepos/nsxiv.svg">
51+ <img align="right" width="192" src="https://repology.org/badge/vertical-allrepos/nsxiv.svg">
5652 </a>
5753
5854 nsxiv is available on the following distributions/repositories. If you don't see
@@ -158,18 +154,18 @@ F.A.Q
158154 -----
159155
160156 * Can I open remote urls with nsxiv? <br>
161−Yes, see [nsxiv-url](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-url)
157+Yes, see [nsxiv-url](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-url)
162158
163159 * Can I open all the images in a directory? <br>
164−Yes, see [nsxiv-rifle](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-rifle)
160+Yes, see [nsxiv-rifle](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-rifle)
165161
166162 * Can I set default arguments for nsxiv? <br>
167−Yes, see [nsxiv-env](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-env)
163+Yes, see [nsxiv-env](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-env)
168164
169165 * Can I pipe images into nsxiv? <br>
170−Yes, see [nsxiv-pipe](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-pipe)
166+Yes, see [nsxiv-pipe](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-pipe)
171167
172−You may also wish to see the [known issues](https://github.com/nsxiv/nsxiv/issues/242).
168+You may also wish to see the [known issues](https://codeberg.org/nsxiv/nsxiv/issues/242).
173169
174170
175171 Customization
@@ -178,11 +174,11 @@ Customization
178174 The main method of customizing nsxiv is by setting values for the variables in *config.h*,
179175 or by using Xresources as explained in the manual. If these options are not sufficient,
180176 you may implement your own features by following
181−[this guide](https://github.com/nsxiv/nsxiv-extra/blob/master/CUSTOMIZATION.md).
177+[this guide](https://codeberg.org/nsxiv/nsxiv-extra/blob/master/CUSTOMIZATION.md).
182178
183179 Due to our limited [project scope](CONTRIBUTING.md#Project-Scope), certain features or
184180 customization cannot be merged into nsxiv mainline. Following the spirit of suckless
185−software, we host the [nsxiv-extra](https://github.com/nsxiv/nsxiv-extra) repo where users
181+software, we host the [nsxiv-extra](https://codeberg.org/nsxiv/nsxiv-extra) repo where users
186182 are free to submit whatever patches or scripts they wish.
187183
188184 If you think your custom features can be beneficial for the general user base and is within
@@ -190,16 +186,16 @@ our project scope, please submit it as a pull request on this repository, then w
190186 merge it to mainline.
191187
192188 Description on how to use or submit patches can be found on
193−nsxiv-extra's [README](https://github.com/nsxiv/nsxiv-extra).
189+nsxiv-extra's [README](https://codeberg.org/nsxiv/nsxiv-extra).
194190
195191
196192 Download
197193 --------
198194
199−You can [browse](https://github.com/nsxiv/nsxiv) the source code repository
200−on GitHub or get a copy using git with the following command:
195+You can [browse](https://codeberg.org/nsxiv/nsxiv) the source code repository
196+on CodeBerg or get a copy using git with the following command:
201197
202− $ git clone https://github.com/nsxiv/nsxiv.git
198+ $ git clone https://codeberg.org/nsxiv/nsxiv.git
203199
204200 You can view the changelog [here](CHANGELOG.md)
205201
M nsxiv.1 View
@@ -550,12 +550,12 @@ For additional contributors, run `git shortlog -s` in the nsxiv repository.
550550 .TP
551551 Website:
552552 .EE
553−https://nsxiv.github.io/nsxiv/
553+https://nsxiv.codeberg.page/
554554 .EX
555555 .TP
556556 Source code:
557557 .EE
558−https://github.com/nsxiv/nsxiv
558+https://codeberg.org/nsxiv/nsxiv
559559 .EX
560560 .SH SEE ALSO
561561 .BR X (7),