From beda52b5758ad51a2fc6302521184587804303ea Mon Sep 17 00:00:00 2001 From: kramo Date: Wed, 10 Jul 2024 16:00:29 +0200 Subject: [PATCH] Add macOS documentation --- CONTRIBUTING.md | 5 +++++ README.md | 9 +++++++-- docs/game_id.json.md | 4 ++-- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b8ab73b..228cc8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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). 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 ```bash git clone https://github.com/kra-mo/cartridges.git diff --git a/README.md b/README.md index 23cd108..8a66c08 100644 --- a/README.md +++ b/README.md @@ -65,8 +65,6 @@ Thank you for your generosity! 💜 ## Linux -### Flathub - The app is available on Flathub. Download on Flathub @@ -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`. +## 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 See [Building](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md#building). diff --git a/docs/game_id.json.md b/docs/game_id.json.md index a886bf0..fd21d69 100644 --- a/docs/game_id.json.md +++ b/docs/game_id.json.md @@ -35,7 +35,7 @@ Stored as a Unix time stamp. 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). @@ -113,4 +113,4 @@ The version number of the [game_id].json specification. Cartridges will set the value for itself. Don't touch it. -Stored as a number. \ No newline at end of file +Stored as a number.