From d19924f288f049228dfc691ccdf13721be3c98f9 Mon Sep 17 00:00:00 2001 From: NRK Date: Thu, 31 Aug 2023 18:06:43 +0000 Subject: [PATCH] various README nits (#470) don't capitalize "berg" in "Codeberg" spelling. Codeberg's official sites does not seem to do so. switch from "GPLv2" to "GPL-2.0-or-later" according to the spdx short identifier: https://spdx.org/licenses/GPL-2.0-or-later.html explicitly mention that Imlib2 needs to be built with X11 support. Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/470 Reviewed-by: explosion-mental --- .github/workflows/lock.yml | 4 ++-- README.md | 14 +++++++------- etc/CHANGELOG.md | 4 ++-- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml index cf187d4..eef34e1 100644 --- a/.github/workflows/lock.yml +++ b/.github/workflows/lock.yml @@ -15,7 +15,7 @@ jobs: 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. + 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. diff --git a/README.md b/README.md index 70376d7..3a3b2d1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ [![nsxiv](https://codeberg.org/nsxiv/pages/raw/branch/master/img/logo.png)](https://codeberg.org/nsxiv/nsxiv) -[![CodeBerg](https://img.shields.io/badge/Hosted_at-Codeberg-%232185D0?style=flat-square&logo=CodeBerg)](https://codeberg.org/nsxiv/nsxiv) +[![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) +[![license](https://img.shields.io/badge/license-GPL--2.0%2B-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** @@ -11,10 +11,10 @@ nsxiv is a fork of the now-unmaintained [sxiv](https://github.com/xyb3rt/sxiv) with the purpose of being a (mostly) drop-in replacement for sxiv, maintaining its interface and adding simple, sensible features. nsxiv is free software licensed -under GPLv2 and aims to be easy to modify and customize. +under GPL-2.0-or-later and aims to be easy to modify and customize. Please file a bug report if something does not work as documented or expected on -[Codeberg] after making sure you are using the latest release. Contributions +[Codeberg] after making sure you are using the latest release. Contributions are welcome, see [CONTRIBUTING] to get started. [Codeberg]: https://codeberg.org/nsxiv/nsxiv/issues/new @@ -64,10 +64,10 @@ Dependencies nsxiv requires the following software to be installed: - * Imlib2 * X11 + * Imlib2 (built with X11 support) -The following dependencies are optional. +The following dependencies are optional: * `inotify`\*: Used for auto-reloading images on change. Disabled via `HAVE_INOTIFY=0`. @@ -206,7 +206,7 @@ Download -------- You can [browse](https://codeberg.org/nsxiv/nsxiv) the source code repository -on CodeBerg or get a copy using git with the following command: +on Codeberg or get a copy using git with the following command: $ git clone https://codeberg.org/nsxiv/nsxiv.git diff --git a/etc/CHANGELOG.md b/etc/CHANGELOG.md index 5ea1259..f89cc95 100644 --- a/etc/CHANGELOG.md +++ b/etc/CHANGELOG.md @@ -57,11 +57,11 @@ there may be more changes. Please use `git log` to view them. - - - ***SPECIAL NOTE***: Due to [this incident](https://codeberg.org/nsxiv/nsxiv-tmp/issues/1) -we have moved development over to [CodeBerg](https://codeberg.org/nsxiv/nsxiv). +we have moved development over to [Codeberg](https://codeberg.org/nsxiv/nsxiv). A lot of the references *below* may now be 404 on GitHub. Any threads which survived the wipe have been migrated over to [nsxiv-record]. All of the -references *above* can be found on the new main nsxiv repository on CodeBerg. +references *above* can be found on the new main nsxiv repository on Codeberg. [nsxiv-record]: https://codeberg.org/nsxiv/nsxiv-record/