From db2993e61cb794331fd683dafc4ff4062bbb24b2 Mon Sep 17 00:00:00 2001 From: Sophie Herold Date: Wed, 26 Feb 2025 23:04:13 +0100 Subject: [PATCH] README: Properly split content with CONTRIBUTING --- CONTRIBUTING.md | 20 ++++++++++++++++++++ README.md | 18 +----------------- 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a23eec3..07f7754 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,23 @@ +# Contributing + +Contributions of all kinds are very welcome. Check the + +- [Welcome to GNOME: Loupe](https://welcome.gnome.org/app/Loupe/) + +pages for more information. If you are manually building Loupe on your system with Builder, make sure that you also have installed the [nightly version](https://welcome.gnome.org/app/Loupe/#installing-a-nightly-build) for all features to work. Otherwise, the development version will not have the required Flatpak permissions. + +Documentation of Loupe's code is available online: + +- [Loupe Code Documentation](https://gnome.pages.gitlab.gnome.org/loupe/doc/loupe/) + +## Issue Tracker + +Issues labeled as ~"1. Feature" or ~"1. Enhancement" are accepted for implementation. Feature requests that still need a decission are labeld as ~"2. RFC". + +## Code of Conduct + +When interacting with the project, the [GNOME Code Of Conduct](https://conduct.gnome.org/) applies. + ## Help format The help pages are currently written in [ducktype](http://projectmallard.org/ducktype/1.0/index.html). The files are stored in `help/C/duck` and the corresponding `.page`-files can be generated via `make -C help/C/`. Afterwards, you can preview the generated help pages via `yelp help/C/index.page`. The generated `.page`-files have to be committed to the repository as well. The `ducktype` program required for running `make` is probably packaged in you distro and is also [availabe on GitHub](https://github.com/projectmallard/mallard-ducktype). diff --git a/README.md b/README.md index b247a88..6720c41 100644 --- a/README.md +++ b/README.md @@ -19,20 +19,4 @@ Image Viewer uses [glycin](https://gitlab.gnome.org/GNOME/glycin) for loading im ## Contributing -Contributions of all kinds are very welcome. Check the - -- [Welcome to GNOME: Loupe](https://welcome.gnome.org/app/Loupe/) - -pages for more information. If you are manually building Loupe on your system with Builder, make sure that you also have installed the [nightly version](https://welcome.gnome.org/app/Loupe/#installing-a-nightly-build) for all features to work. Otherwise, the development version will not have the required Flatpak permissions. - -Documentation of Loupe's code is available online: - -- [Loupe Code Documentation](https://gnome.pages.gitlab.gnome.org/loupe/doc/loupe/) - -### Issue Tracker - -Issues labeled as ~"1. Feature" or ~"1. Enhancement" are accepted for implementation. Feature requests that still need a decission are labeld as ~"2. RFC". - -### Code of Conduct - -When interacting with the project, the [GNOME Code Of Conduct](https://conduct.gnome.org/) applies. +For informations on how to contribute, please check the [CONTRIBUTING.md](CONTRIBUTING.md).