From 3cbabf0f80150208aa5319ea4ceb77da1b62b82d Mon Sep 17 00:00:00 2001 From: Dom Date: Fri, 27 Nov 2020 20:32:29 +0000 Subject: [PATCH] docs(README): document clang requirement (#498) Found while investigating #465 - clang is needed to build the croaring dependency. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 51735b6b3b..aeac0766fa 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,22 @@ compilation process by calling `flatc` for you. [`flatbuffers` package for Arch Linux]: https://www.archlinux.org/packages/community/x86_64/flatbuffers/ [`flatbuffers` package for Homebrew]: https://github.com/Homebrew/homebrew-core/blob/HEAD/Formula/flatbuffers.rb +### Installing `clang` + +An installation of `clang` is required to build the [`croaring`] dependency - if +it is not already present, it can typically be installed with the system +package manager. + +```shell +clang --version +Apple clang version 12.0.0 (clang-1200.0.32.27) +Target: x86_64-apple-darwin20.1.0 +Thread model: posix +InstalledDir: /Library/Developer/CommandLineTools/usr/bin +``` + +[`croaring`]: https://github.com/saulius/croaring-rs + ### Specifying Configuration **OPTIONAL:** There are a number of configuration variables you can choose to customize by