From 6acdee0813c6aec893495e74c1dea0c1e4a3f865 Mon Sep 17 00:00:00 2001
From: Camila Ayres <hello@camilasan.com>
Date: Tue, 1 Oct 2024 17:13:25 +0200
Subject: [PATCH] Add README about mac-crafter.

Signed-off-by: Camila Ayres <hello@camilasan.com>
---
 admin/osx/mac-crafter/README.md | 79 +++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 admin/osx/mac-crafter/README.md

diff --git a/admin/osx/mac-crafter/README.md b/admin/osx/mac-crafter/README.md
new file mode 100644
index 000000000..572d5e519
--- /dev/null
+++ b/admin/osx/mac-crafter/README.md
@@ -0,0 +1,79 @@
+# mac-crafter
+
+A tool to easily build a fully-functional Nextcloud Desktop Client for macOS.
+
+It will create the application bundle with the option to sign it, which is required by Apple when running and debugging the file provider module.
+
+## System requirements
+
+- Mac OS > 11
+- XCode
+- Python
+
+## Step by step usage
+
+1. Clone the desktop client in your mac OS
+```
+https://github.com/nextcloud/desktop.git
+```
+
+2. Create the build folder
+```
+mkdir <build folder>
+```
+
+3. Build the desktop client:
+```
+swift run --build-path <build folder> --package-path <cloned desktop repo>/admin/osx/mac-crafter mac-crafter <cloned desktop repo>
+```
+
+3.1 Sign the application bundle by adding the following parameter:
+`-c "Apple Development: <certificate common name>"`
+The whole command will look like this:
+```
+swift run --build-path <build folder> --package-path <cloned desktop repo>/admin/osx/mac-crafter mac-crafter <cloned desktop repo> -c "Apple Development: <certificate common name>"
+```
+
+> [!TIP] 
+> Check [Apple's oficial documentation about code signing](https://developer.apple.com/documentation/xcode/using-the-latest-code-signature-format).
+
+3.2 Build the file provider module with this option:
+```
+--build-file-provider-module
+```
+
+3.3 Disable the auto-updater:
+```
+--disable-autoupdater
+```
+
+3.4 Set the architecture you are building for:
+
+```
+--arch arm64
+```
+
+The options are `x86_64` and `arm64`.
+
+### How to build the app bundle for arm and intel
+
+To achieve this we are using [KDE Craft](https://community.kde.org/Craft).
+
+1. After running the steps above, you will be able to use the `CraftMaster.py` script for that:
+
+```
+python build/craftmaster/CraftMaster.py --config <cloned desktop repo>/craftmaster.ini --target macos-clang-arm64 -c --add-blueprint-repository https://github.com/nextcloud/desktop-client-blueprints/
+```
+
+The `--target` options are define in the [`craftmaster.ini` file](https://github.com/nextcloud/desktop/blob/c771c4166c806d686d9b4f8b11e33d8d95631398/craftmaster.ini).
+
+2. Install the client dependencies
+```
+python build/craftmaster/CraftMaster.py --config <cloned desktop repo>/craftmaster.ini --target macos-clang-arm64 -c --install-deps nextcloud-client
+```
+
+3. Build the client
+
+```
+python build/craftmaster/CraftMaster.py --config <cloned desktop repo>/craftmaster.ini --target macos-clang-arm64 -c --src-dir <cloned desktop repo> nextcloud-client
+```