From 149c41790167faef92c26fd705d601526272b7ac Mon Sep 17 00:00:00 2001 From: kramo <93832451+kra-mo@users.noreply.github.com> Date: Sun, 19 Mar 2023 16:40:30 +0100 Subject: [PATCH] Update README.md --- README.md | 58 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 33 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 41dacc5..09ea137 100644 --- a/README.md +++ b/README.md @@ -25,49 +25,57 @@ - -## The Project +# The Project Cartridges is a simple game launcher written in Python using GTK4 + Libadwaita. -### Features +## Features - Manually adding and editing games - Importing games from Steam, Heroic and Bottles - Hiding games - Searching and sorting by title, date added and last played -## Building +# Installation -### GNOME Builder - -1. Download [GNOME Builder](https://flathub.org/apps/details/org.gnome.Builder). -2. Click "Clone Repository" with `https://github.com/kra-mo/game-shelf.git` as the URL. -3. Click on the build button (hammer) at the top. - -## Installation - -### Latest Build From GitHub Actions -1. Install `org.gnome.Platform` from the [gnome-nightly repository](https://wiki.gnome.org/Apps/Nightly) if needed. -2. Download the artifact from the latest workflow run. -3. Decompress the archive. -4. Install it via GNOME Software or `flatpak install hu.kramo.Cartridges.flatpak`. +## Linux ### From Releases 1. Install `org.gnome.Platform` from the [gnome-nightly repository](https://wiki.gnome.org/Apps/Nightly) if needed. -2. Download the latest release from Releases. +2. Download the latest release from [Releases](https://github.com/kra-mo/cartridges/releases). 3. Install it via GNOME Software or `flatpak install hu.kramo.Cartridges.flatpak`. -### From GNOME Builder -Click the down arrow next to the hammer at the top of your GNOME Builder window, then click "Export". This will create a flatpak that then can be installed on your system. +## Windows -## Contributing +### From Releases +1. Download the latest release from [Releases](https://github.com/kra-mo/cartridges/releases). +2. Run the downloaded installer. -### Code +Note: Windows might present you with a warning when trying to install the app. This is expected, just ignore the warning. + +# 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 build +ninja -C build install +``` + +# Contributing + +## Code Fork the repository, make your changes, then create a pull request. -### Translations -#### Weblate +## Translations +### Weblate The project can be translated on [Weblate](https://hosted.weblate.org/projects/cartridges/). -#### Manually +### 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/).