docs(README): document clang requirement (#498)

Found while investigating #465 - clang is needed to build the croaring
dependency.
pull/24376/head
Dom 2020-11-27 20:32:29 +00:00 committed by GitHub
parent 46d58dfec5
commit 3cbabf0f80
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions

View File

@ -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