Skip to content

Commit

Permalink
Update README info
Browse files Browse the repository at this point in the history
  • Loading branch information
kra-mo committed Mar 22, 2023
1 parent 6176982 commit 7503d20
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@
</div>

# 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

Expand All @@ -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

Expand All @@ -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).
Expand Down

0 comments on commit 7503d20

Please sign in to comment.