docs: add documentation on macOS binary, add open graph image (#7)

* docs: add documentation on macOS binary * docs: add open graph image
Wandmalfarbe · Dec 28, 2023 · 398c09b · 398c09b
1 parent 20fc1c4
commit 398c09b
Show file tree

Hide file tree

Showing 4 changed files with 104 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -24,6 +24,9 @@ Download the correct version of the application for your operating system on the
 
 ### macOS
 
+> [!IMPORTANT]  
+> ARM based Macs are currently unsupported. The macOS application or the JAR file will only run on intel based Macs.
+
 1. Double-click the downloaded disk image (DMG file).
 2. Drag the application `EPUBCheckFX` into the `Application` folder.
 3. Start the application `EPUBCheckFX` from the `Application` folder by double-clicking.

diff --git a/img/open-graph.png b/img/open-graph.png
diff --git a/img/open-graph.svg b/img/open-graph.svg
diff --git a/pom.xml b/pom.xml
@@ -388,7 +388,7 @@
                     <dmg>
                         <generate>true</generate>
                         <appendVersion>false</appendVersion>
-                        <dmgFileName>${project.name}-${project.version}-macOS</dmgFileName>
+                        <dmgFileName>${project.name}-${project.version}-macOS-x86_64</dmgFileName>
                     </dmg>
                 </configuration>
                 <executions>