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

Update README.md

Browse Source
This commit is contained in:
kramo
2023-03-19 16:40:30 +01:00
committed by GitHub
parent fd6bb12e82
commit 149c417901
1 changed files with 33 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@@ -25,49 +25,57 @@
<img src="data/screenshot.webp"> <img src="data/screenshot.webp">
</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 + 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
- Hiding games - Hiding games
- Searching and sorting by title, date added and last played - Searching and sorting by title, date added and last played
## Building # Installation
### GNOME Builder ## Linux
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`.
### From Releases ### From Releases
1. Install `org.gnome.Platform` from the [gnome-nightly repository](https://wiki.gnome.org/Apps/Nightly) if needed. 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`. 3. Install it via GNOME Software or `flatpak install hu.kramo.Cartridges.flatpak`.
### From GNOME Builder ## Windows
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.
## 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. Fork the repository, make your changes, then create a pull request.
### Translations ## Translations
#### Weblate ### Weblate
The project can be translated on [Weblate](https://hosted.weblate.org/projects/cartridges/). The project can be translated on [Weblate](https://hosted.weblate.org/projects/cartridges/).
#### Manually ### Manually
1. Clone the repository. 1. Clone the repository.
2. If it isn't already there, add your language to `/po/LINGUAS`. 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/). 3. Create a new translation from the `/po/cartridges.pot` file with a translation editor such as [Poedit](https://poedit.net/).