README.md in numo-openblas-0.4.5 vs README.md in numo-openblas-0.4.6

- old
+ new

@@ -31,13 +31,35 @@ Or install it yourself as: $ gem install numo-openblas -Note: Numo::OpenBLAS downloads and builds OpenBLAS during installation. -In many cases, building OpenBLAS takes a lot of time. +Note: +Numo::OpenBLAS downloads and builds OpenBLAS during installation. In many cases, building OpenBLAS takes a lot of time. +In addtion, the building OpenBLAS may fail on Apple M1 mac due to linker error: +```sh +ld: warning: object file (...) was built for newer macOS version (...) than being linked (...) +... +Undefined symbols for architecture arm64: + "___chkstk_darwin", referenced from: + _sgemv_ in libopenblas_vortexp-r0.3.19.a(sgemv.o) + _sger_ in libopenblas_vortexp-r0.3.19.a(sger.o) + _cblas_sgemv in libopenblas_vortexp-r0.3.19.a(cblas_sgemv.o) + _cblas_sger in libopenblas_vortexp-r0.3.19.a(cblas_sger.o) + _dgemv_ in libopenblas_vortexp-r0.3.19.a(dgemv.o) + _dger_ in libopenblas_vortexp-r0.3.19.a(dger.o) + _cblas_dgemv in libopenblas_vortexp-r0.3.19.a(cblas_dgemv.o) + ... +ld: symbol(s) not found for architecture arm64 +``` + +In that case, you can install it by giving `MACOSX_DEPLOYMENT_TARGET` your mac version. +If you are using macOS Monterey, the installation command would be: + + $ MACOSX_DEPLOYMENT_TARGET=12.0 gem install numo-openblas + ## Usage Numo::OpenBLAS loads Numo::NArray and Numo::Linalg using OpenBLAS as a background library. You can use Numo::NArray and Numo::Linalg just by loading Numo::OpenBLAS. @@ -60,14 +82,12 @@ => 8 ``` ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/numo-openblas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/yoshoku/numo-openblas/blob/main/CODE_OF_CONDUCT.md). +Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/numo-openblas. +This project is intended to be a safe, welcoming space for collaboration, +and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License The gem is available as open source under the terms of the [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause). - -## Code of Conduct - -Everyone interacting in the Numo::Openblas project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/numo-openblas/blob/main/CODE_OF_CONDUCT.md).