skullbite/cartridges
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README info

Browse Source
This commit is contained in:
kramo
2023-03-22 17:32:06 +01:00
parent 6176982d1c
commit 7503d207c8
2 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -17,11 +17,15 @@ The project can be translated on [Weblate](https://hosted.weblate.org/engage/car
# Building # Building
## GNOME Builder ## GNOME Builder
1. Install [GNOME Builder](https://flathub.org/apps/details/org.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. 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. 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 ## Meson
```bash ```bash
git clone https://github.com/kra-mo/cartridges.git git clone https://github.com/kra-mo/cartridges.git

11
README.md
View File

@@ -23,10 +23,11 @@
</div> </div>
# The Project # 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 ## Features
- Manually adding and editing games - Manually adding and editing games
- Importing games from Steam, Heroic and Bottles - Importing games from Steam, Heroic and Bottles
- Support for multiple Steam install locations
- Hiding games - Hiding games
- Searching and sorting by title, date added and last played - 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 ## Linux
### From Releases ### From Releases
1. Install `org.gnome.Platform` from the [gnome-nightly repository](https://wiki.gnome.org/Apps/Nightly) if needed. 1. Download the latest release from [Releases](https://github.com/kra-mo/cartridges/releases).
2. 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`.
3. Install it via GNOME Software or `flatpak install hu.kramo.Cartridges.flatpak`.
## Windows ## 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. 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 # Contributing
See [CONTRIBUTING](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md). See [CONTRIBUTING](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md).