Skip to content

Commit

Permalink
Add note about planned Mac version
Browse files Browse the repository at this point in the history
  • Loading branch information
mtkennerly committed Nov 28, 2024
1 parent fa46719 commit 2639a14
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ If you'd like to help translate Madamiru into other languages,
> ![GUI demo](docs/demo-gui.gif)
## Installation
Download the executable for Windows, Linux, or Mac from the
Download the executable for Windows or Linux from the
[releases page](https://github.com/mtkennerly/madamiru/releases).
It's portable, so you can simply download it and put it anywhere on your system.

A Mac version is planned, but not yet available.

<!--
If you prefer, Madamiru is also available via
[Winget, Scoop, Flatpak, and Cargo](docs/help/installation.md).
Expand All @@ -28,10 +30,12 @@ Note:
"Windows protected your PC",
because Windows does not recognize the program's publisher.
Click "more info" and then "run anyway" to start the program.
<!--
* Mac users may see a popup that says
"Madamiru can't be opened because it is from an unidentified developer".
To allow Madamiru to run, please refer to [this article](https://support.apple.com/en-us/102445),
specifically the section on `If you want to open an app [...] from an unidentified developer`.
-->

## Usage
Detailed help documentation is available for several topics.
Expand Down
5 changes: 4 additions & 1 deletion docs/help/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Installation
## Requirements
* Madamiru is available for Windows, Linux, and Mac.
* Madamiru is available for Windows and Linux.
A Mac version is planned, but not yet available.
* For the best performance, your system should support one of DirectX, Vulkan, or Metal.
For other systems, Madamiru will use a fallback software renderer,
or you can also activate the software renderer by setting the `ICED_BACKEND` environment variable to `tiny-skia`.
Expand Down Expand Up @@ -46,9 +47,11 @@ If you are on Windows:
because Windows does not recognize the program's publisher.
Click "more info" and then "run anyway" to start the program.

<!--
If you are on Mac:
* When you first run Madamiru, you may see a popup that says
"Madamiru can't be opened because it is from an unidentified developer".
To allow Madamiru to run, please refer to [this article](https://support.apple.com/en-us/102445),
specifically the section on `If you want to open an app [...] from an unidentified developer`.
-->

0 comments on commit 2639a14

Please sign in to comment.