From 9f010f2ea09a3908cb709d2f6bdacdf0335bfdd6 Mon Sep 17 00:00:00 2001
From: kousuke-nakano <37653569+kousuke-nakano@users.noreply.github.com>
Date: Fri, 15 Sep 2023 12:02:25 +0900
Subject: [PATCH] Update python/README.md

I have added a known issue and a workaround about `pip install trexio` on an ARM64 machine to python/README.md
---
 python/README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/python/README.md b/python/README.md
index 078389cd..8c95b88d 100644
--- a/python/README.md
+++ b/python/README.md
@@ -27,6 +27,10 @@ However, it is good practice to first check for updates of the build-system pack
 **Note: we highly recommend to use virtual environments to avoid compatibility issues and to improve reproducibility.**
 For more details, see the corresponding part of the [Python documentation](https://docs.python.org/3/library/venv.html#creating-virtual-environments).
 
+**Note: our build farm (GitHub Actions) does not support ARM64 architectures (including the Mac M1/M2 chips). Therefore, `pip install trexio` does not work on an ARM64-based machine. Thus, we recommend to install TREXIO from source on an ARM64-based machine. If one uses a Mac where HDF5 is installed with brew (i.e., `brew install hdf5`), a workaround is to execute the following 2 lines before doing `pip install trexio`:**
+
+- `export H5_CFLAGS="-I$(brew --prefix hdf5)/include"`
+- `export H5_LDFLAGS="-L$(brew --prefix hdf5)/lib"`
 
 ## Additional requirements (for installation from source)