From ba75f36b3963a5cc6fb02f518c283baf58d43c4d Mon Sep 17 00:00:00 2001 From: Shane Utt Date: Wed, 28 Feb 2024 09:11:47 -0500 Subject: [PATCH] docs: add build requirements to README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index cd80748..4b3799d 100644 --- a/README.md +++ b/README.md @@ -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).