From 9724cae88437c2947b60e42d115200fc6aa53784 Mon Sep 17 00:00:00 2001 From: kramo <93832451+kra-mo@users.noreply.github.com> Date: Tue, 21 Mar 2023 16:15:43 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c472e92 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +## Code +Fork the repository, make your changes, then create a pull request. + +## Translations +### Weblate +The project can be translated on [Weblate](https://hosted.weblate.org/engage/cartridges/). + +### Manually +1. Clone the repository. +2. If it isn't already there, add your language to `/po/LINGUAS`. +3. Create a new translation from the `/po/cartridges.pot` file with a translation editor such as [Poedit](https://poedit.net/). +4. Save the file as `[YOUR LANGUAGE CODE].po` to `/po/`. +5. Create a pull request with your translations. + +# Building + +## GNOME Builder + +1. Download [GNOME Builder](https://flathub.org/apps/details/org.gnome.Builder). +2. Click "Clone Repository" with `https://github.com/kra-mo/cartridges.git` as the URL. +3. Click on the build button (hammer) at the top. + +## Meson +```bash +git clone https://github.com/kra-mo/cartridges.git +cd cartridges +meson setup build +ninja -C build install +```