docs: add build requirements to README.md

This commit is contained in:
Shane Utt 2024-02-28 09:11:47 -05:00
parent 8797329225
commit ba75f36b39
No known key found for this signature in database
GPG key ID: 2A0C1E3016ECC921

View file

@ -58,6 +58,17 @@ Pingora keeps a rolling MSRV (minimum supported Rust version) policy of 6 months
Our current MSRV is 1.72.
## Build Requirements
Some of the crates in this repository have dependencies on additional tools and
libraries that must be satisfied in order to build them:
* Make sure that [Clang] is installed on your system (for boringssl)
* Make sure that [Perl 5] is installed on your system (for openssl)
[Clang]:https://clang.llvm.org/
[Perl 5]:https://www.perl.org/
# Contributing
Please see our [contribution guidelines](./.github/CONTRIBUTING.md).