docs: add build requirements to README.md

Includes-commit: ba75f36b39
Replicated-from: https://github.com/cloudflare/pingora/pull/7
This commit is contained in:
Shane Utt 2024-02-28 14:11:47 +00:00 committed by Kevin Guthrie
parent 2631da74b0
commit 586781a685
2 changed files with 12 additions and 1 deletions

2
.bleep
View file

@ -1 +1 @@
9d19d79b4015f2730c6213b9c20d9787e7ed896a
0460a7c567a3dcb3cc2f9940a8c8bc3307036fb2

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).