From 7503d207c8959b3756ac96f813a086653c7406d2 Mon Sep 17 00:00:00 2001 From: kramo <93832451+kra-mo@users.noreply.github.com> Date: Wed, 22 Mar 2023 17:32:06 +0100 Subject: [PATCH] Update README info --- CONTRIBUTING.md | 8 ++++++-- README.md | 11 +++++++---- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c472e92..f8b53e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,11 +17,15 @@ The project can be translated on [Weblate](https://hosted.weblate.org/engage/car # Building ## GNOME Builder - -1. Download [GNOME Builder](https://flathub.org/apps/details/org.gnome.Builder). +1. Install [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. +## For Windows +1. Install [MSYS2](https://www.msys2.org/). +2. From the MSYS2 shell, install the required dependencies listed [here](https://github.com/kra-mo/cartridges/blob/main/.github/workflows/windows.yml). +3. Build it via Meson + ## Meson ```bash git clone https://github.com/kra-mo/cartridges.git diff --git a/README.md b/README.md index 96b070e..16973e4 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,11 @@ # The Project -Cartridges is a simple game launcher written in Python using GTK4 + Libadwaita. +Cartridges is a simple game launcher written in Python using GTK4 and Libadwaita. ## Features - Manually adding and editing games - Importing games from Steam, Heroic and Bottles +- Support for multiple Steam install locations - Hiding games - Searching and sorting by title, date added and last played @@ -35,9 +36,8 @@ Cartridges is a simple game launcher written in Python using GTK4 + Libadwaita. ## 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](https://github.com/kra-mo/cartridges/releases). -3. Install it via GNOME Software or `flatpak install hu.kramo.Cartridges.flatpak`. +1. Download the latest release from [Releases](https://github.com/kra-mo/cartridges/releases). +2. Install the downloaded file via GNOME Software or `flatpak install hu.kramo.Cartridges.flatpak`. ## Windows @@ -47,6 +47,9 @@ Cartridges is a simple game launcher written in Python using GTK4 + Libadwaita. Note: Windows might present you with a warning when trying to install the app. This is expected, just ignore the warning. +## Building manually +See [Building](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md#building). + # Contributing See [CONTRIBUTING](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md).