Move over to codeberg (#293)

Reviewed-by: Berke Kocaoğlu <berke.kocaoglu@metu.edu.tr>
This commit is contained in:
NRK 2022-06-11 15:38:07 +02:00
parent 09d2d738ad
commit 4c6d26bef4
4 changed files with 68 additions and 31 deletions

21
.github/workflows/lock.yml vendored Normal file
View File

@ -0,0 +1,21 @@
name: 'Repo Lockdown'
on:
pull_request_target:
types: opened
permissions:
pull-requests: write
jobs:
action:
runs-on: ubuntu-latest
steps:
- uses: dessant/repo-lockdown@v2
with:
pr-comment: >
Hi, thanks for the Pull-Request.
However this repository is a read-only mirror, main development of nsxiv happens over at [CodeBerg](https://codeberg.org/nsxiv/nsxiv).
Please open your Pull-Request over on the CodeBerg Repo.
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.

View File

@ -12,6 +12,10 @@ 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.
Also note that (n)sxiv uses `imlib2` for loading images. Thus any request or
patches for adding support for new image formats should go into
[imlib2's repo](https://git.enlightenment.org/old/legacy-imlib2) instead.
Contribution Guideline
----------------------
@ -28,17 +32,18 @@ If your contribution is not suitable for general use, it will not be included in
For changes that are very much up to preference, such as changing values in config.h,
please do not open a pull request unless you have an objective explanation.
See the [open issues](https://github.com/nsxiv/nsxiv/issues) to find something
See the [open issues](https://codeberg.org/nsxiv/nsxiv/issues) to find something
to work on. You can also filter the issues via label:
* [Good first issue](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22):
* [Good first issue](https://codeberg.org/nsxiv/nsxiv/issues?labels=49698):
(Easy) Issues which do not require much if any experience.
* [Up for grabs](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22):
* [Up for grabs](https://codeberg.org/nsxiv/nsxiv/issues?labels=49705):
(Intermediate) Issues which are free for anyone who wants to pick it up.
Might require some experience.
* [Help wanted](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22):
* [Help wanted](https://codeberg.org/nsxiv/nsxiv/issues?labels=49699):
(Intermediate/Experienced) Issues where we require some help.
Development workflow for maintainers
------------------------------------
@ -69,6 +74,21 @@ For releases, the process is the following:
release, the "Added" section for new features, and the "Fixes" section
for fixed bugs or regressions. Include pull request IDs.
Mirroring to GitHub:
Assuming `origin` is the name of the codeberg remote and `github` is the name
of the github remote; run the following commands to mirror the codeberg repo to
github:
```console
$ git fetch --prune origin
$ git push --prune github '+refs/remotes/origin/*:refs/heads/*' '+refs/tags/*:refs/tags/*'
```
The first command updates the local repo and the second command pushes
everything on `origin` without pushing any of the local branches.
- - -
For mundane development related talks which don't warrant their own issue, use
the [general-dev](https://github.com/nsxiv/nsxiv/discussions/119) discussion
thread.
the [general discussion](https://codeberg.org/nsxiv/nsxiv/issues/294) thread.

View File

@ -1,13 +1,9 @@
[![nsxiv](https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/logo.png)](https://github.com/nsxiv/nsxiv)
[![nsxiv](https://codeberg.org/nsxiv/pages/raw/branch/master/img/logo.png)](https://codeberg.org/nsxiv/nsxiv)
[![tags](https://img.shields.io/github/v/tag/nsxiv/nsxiv?style=flat-square)](https://github.com/nsxiv/nsxiv/tags)
[![license](https://img.shields.io/badge/license-GPL--2.0-lightgreen?style=flat-square)](https://github.com/nsxiv/nsxiv/blob/master/LICENSE)
[![loc](https://img.shields.io/tokei/lines/github/nsxiv/nsxiv?color=red&style=flat-square)](https://github.com/nsxiv/nsxiv)
<p align="center">
<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>
<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>
</p>
[![CodeBerg](https://img.shields.io/badge/Hosted_at-Codeberg-%232185D0?style=flat-square&logo=CodeBerg)](https://codeberg.org/nsxiv/nsxiv)
[![tags](https://img.shields.io/github/v/tag/nsxiv/nsxiv?style=flat-square)](https://codeberg.org/nsxiv/nsxiv/tags)
[![license](https://img.shields.io/badge/license-GPL--2.0-lightgreen?style=flat-square)](https://codeberg.org/nsxiv/nsxiv/src/branch/master/LICENSE)
[![loc](https://img.shields.io/tokei/lines/github/nsxiv/nsxiv?color=red&style=flat-square)](https://codeberg.org/nsxiv/nsxiv)
**Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer**
--------------------------------------------------------------------
@ -41,11 +37,11 @@ Screenshots
**Image mode: (Default colors)**
![Image](https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/image.png "Image mode")
![Image](https://codeberg.org/nsxiv/pages/raw/branch/master/img/image.png "Image mode")
**Thumbnail mode: (Custom colors)**
![Thumb](https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/thumb.png "Thumb mode")
![Thumb](https://codeberg.org/nsxiv/pages/raw/branch/master/img/thumb.png "Thumb mode")
Installing via package manager
@ -158,18 +154,18 @@ F.A.Q
-----
* Can I open remote urls with nsxiv? <br>
Yes, see [nsxiv-url](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-url)
Yes, see [nsxiv-url](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-url)
* Can I open all the images in a directory? <br>
Yes, see [nsxiv-rifle](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-rifle)
Yes, see [nsxiv-rifle](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-rifle)
* Can I set default arguments for nsxiv? <br>
Yes, see [nsxiv-env](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-env)
Yes, see [nsxiv-env](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-env)
* Can I pipe images into nsxiv? <br>
Yes, see [nsxiv-pipe](https://github.com/nsxiv/nsxiv-extra/tree/master/scripts/nsxiv-pipe)
Yes, see [nsxiv-pipe](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-pipe)
You may also wish to see the [known issues](https://github.com/nsxiv/nsxiv/issues/242).
You may also wish to see the [known issues](https://codeberg.org/nsxiv/nsxiv/issues/242).
Customization
@ -178,11 +174,11 @@ Customization
The main method of customizing nsxiv is by setting values for the variables in *config.h*,
or by using Xresources as explained in the manual. If these options are not sufficient,
you may implement your own features by following
[this guide](https://github.com/nsxiv/nsxiv-extra/blob/master/CUSTOMIZATION.md).
[this guide](https://codeberg.org/nsxiv/nsxiv-extra/blob/master/CUSTOMIZATION.md).
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
software, we host the [nsxiv-extra](https://codeberg.org/nsxiv/nsxiv-extra) repo where users
are free to submit whatever patches or scripts they wish.
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
merge it to mainline.
Description on how to use or submit patches can be found on
nsxiv-extra's [README](https://github.com/nsxiv/nsxiv-extra).
nsxiv-extra's [README](https://codeberg.org/nsxiv/nsxiv-extra).
Download
--------
You can [browse](https://github.com/nsxiv/nsxiv) the source code repository
on GitHub or get a copy using git with the following command:
You can [browse](https://codeberg.org/nsxiv/nsxiv) the source code repository
on CodeBerg or get a copy using git with the following command:
$ git clone https://github.com/nsxiv/nsxiv.git
$ git clone https://codeberg.org/nsxiv/nsxiv.git
You can view the changelog [here](CHANGELOG.md)

View File

@ -550,12 +550,12 @@ For additional contributors, run `git shortlog -s` in the nsxiv repository.
.TP
Website:
.EE
https://nsxiv.github.io/nsxiv/
https://nsxiv.codeberg.page/
.EX
.TP
Source code:
.EE
https://github.com/nsxiv/nsxiv
https://codeberg.org/nsxiv/nsxiv
.EX
.SH SEE ALSO
.BR X (7),