Merge pull request #65 from freakboy3742/readme-update

Add a README note about being macOS specific.
dmgbuild · Nov 15, 2023 · 62c6b5e · 62c6b5e
2 parents b7de655 + aa06e44
commit 62c6b5e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -39,6 +39,9 @@ when the user opens it.
 without relying on Finder, and without using deprecated APIs (like the
 Alias Manager functions).
 
+``dmgbuild`` is a wrapper around macOS specific tools, so it can't be used on
+Windows or Linux.
+
 See the documentation_ for more information.
 
 .. _documentation: http://dmgbuild.readthedocs.io
diff --git a/docs/index.rst b/docs/index.rst
@@ -27,6 +27,9 @@ APIs (like the Alias Manager functions).  Instead, it uses the
 ``ds_store`` and ``mac_alias`` Python modules, which know how to
 construct the relevant data in Python code.
 
+As ``dmgbuild`` is a wrapper around macOS specific tools, it can't be used on
+Windows or Linux.
+
 Contents:
 
 .. toctree::