From 586781a6850c86606171ad6dc17c0814e036bb83 Mon Sep 17 00:00:00 2001 From: Shane Utt Date: Wed, 28 Feb 2024 14:11:47 +0000 Subject: [PATCH] docs: add build requirements to README.md Includes-commit: ba75f36b3963a5cc6fb02f518c283baf58d43c4d Replicated-from: https://github.com/cloudflare/pingora/pull/7 --- .bleep | 2 +- README.md | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/.bleep b/.bleep index 384af31..6426a33 100644 --- a/.bleep +++ b/.bleep @@ -1 +1 @@ -9d19d79b4015f2730c6213b9c20d9787e7ed896a \ No newline at end of file +0460a7c567a3dcb3cc2f9940a8c8bc3307036fb2 \ No newline at end of file diff --git a/README.md b/README.md index aae1ef2..4ccfa3f 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).