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

Add macOS documentation

Browse Source
This commit is contained in:
kramo
2024-07-10 16:00:29 +02:00
parent 13cefac34d
commit beda52b575
3 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@@ -33,6 +33,11 @@ The project can be translated on [Weblate](https://hosted.weblate.org/engage/car
2. From the MSYS2 shell, install the required dependencies listed [here](https://github.com/kra-mo/cartridges/blob/main/.github/workflows/ci.yml). 2. From the MSYS2 shell, install the required dependencies listed [here](https://github.com/kra-mo/cartridges/blob/main/.github/workflows/ci.yml).
3. Build it via Meson. 3. Build it via Meson.
## For macOS
1. Install [Homebrew](https://brew.sh/).
2. Using `brew` and `pip3`, install the required dependencies listed [here](https://github.com/kra-mo/cartridges/blob/main/.github/workflows/ci.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

9
README.md
View File

@@ -65,8 +65,6 @@ Thank you for your generosity! 💜
## Linux ## Linux
### Flathub
The app is available on Flathub. The app is available on Flathub.
<a href=https://flathub.org/apps/page.kramo.Cartridges><img alt='Download on Flathub' src='https://flathub.org/api/badge?svg&locale=en'/></a> <a href=https://flathub.org/apps/page.kramo.Cartridges><img alt='Download on Flathub' src='https://flathub.org/api/badge?svg&locale=en'/></a>
@@ -84,6 +82,13 @@ Note: Windows might present you with a warning when trying to install the app. T
Install the latest release with the command: `winget install cartridges`. Install the latest release with the command: `winget install cartridges`.
## macOS
1. Download the latest release from [Releases](https://github.com/kra-mo/cartridges/releases).
2. Move the app into your Applications folder.
Note: macOS might tell you that the application could not be checked for malicious software or something similar. In this case, open System Settings > Privacy & Security, scroll down, find the warning about Cartridges and click "Open Anyway". More information can be found [here](https://support.apple.com/en-us/102445).
## Building manually ## Building manually
See [Building](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md#building). See [Building](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md#building).

4
docs/game_id.json.md
View File

@@ -35,7 +35,7 @@ Stored as a Unix time stamp.
The executable to run when launching a game. The executable to run when launching a game.
If the source has a URL handler, using that is preferred. In that case, the value should be `"xdg-open url://example/url"` for Linux and `"start url://example/url"` for Windows. If the source has a URL handler, using that is preferred. In that case, the value should be `"xdg-open url://example/url"` for Linux, `"start url://example/url"` for Windows and `"open url://example/url"` for macOS.
Stored as either a string (preferred) or an argument vector to be passed to the shell through [subprocess.Popen](https://docs.python.org/3/library/subprocess.html#popen-constructor). Stored as either a string (preferred) or an argument vector to be passed to the shell through [subprocess.Popen](https://docs.python.org/3/library/subprocess.html#popen-constructor).
@@ -113,4 +113,4 @@ The version number of the [game_id].json specification.
Cartridges will set the value for itself. Don't touch it. Cartridges will set the value for itself. Don't touch it.
Stored as a number. Stored as a number.