From bbda3e9054306825a5d6401c5fce9a6e46d5ef2c Mon Sep 17 00:00:00 2001
From: shirakaba <14055146+shirakaba@users.noreply.github.com>
Date: Wed, 4 Jan 2023 12:12:17 +0900
Subject: [PATCH] chore: ARM Mac installation instructions

---
 readme.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/readme.md b/readme.md
index 1819020..9e3fda8 100644
--- a/readme.md
+++ b/readme.md
@@ -9,6 +9,7 @@
 $ npm install --save objc
 ```
 
+*Note: on ARM Macs, you may need to prepend `npm_config_build_from_source=true` to this command as the subdependency [ref-napi](https://github.com/node-ffi-napi/ref-napi) (as of version 3.0.3) does not include a prebuilt bindary for `darwin-arm64`. See "troubleshooting" below for more information.*
 
 ## Usage
 
@@ -247,6 +248,23 @@ LKGreeter.new().greet('Lukas'); // => 'Hello, Lukas!'
 ```
 **Note**: You might have to specify individual offsets in the type encoding, see [this example](/examples/delegate.js).
 
+## Troubleshooting
+
+### "No native build was found"
+
+If, at runtime (e.g. when running `npm run test`), you encounter this error:
+
+> Error: No native build was found for `platform=darwin arch=arm64 runtime=node abi=93 uv=1 armv=8 libc=glibc node=16.19.0`
+> loaded from: `/Users/some_user/objc/node_modules/ref-napi`
+
+... it's because the [ref-napi](https://github.com/node-ffi-napi/ref-napi) release (as of version 3.0.3) includes [prebuilt binaries for various processors, but not for `darwin-arm64` as used on ARM Macs](https://github.com/node-ffi-napi/ref-napi/issues/51#issuecomment-991746870).
+
+To work around this, either switch your terminal to Rosetta mode (not recommended), or (probably best to remove `node_modules`, then) reinstall with this environment arg:
+
+```sh
+npm_config_build_from_source=true npm install --save objc
+```
+
 ## Roadmap
 In the future, I'd like to add support for:
 - improved support for inout parameters (`id*`)