aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorShane Utt <[email protected]>2024-02-28 14:11:47 +0000
committerKevin Guthrie <[email protected]>2024-04-26 12:31:57 -0400
commit586781a6850c86606171ad6dc17c0814e036bb83 (patch)
tree05dfe325a145e4e13e1ee0daee509da849747ac9 /README.md
parent2631da74b08f24a49a0f83e5c666b11b4da25673 (diff)
downloadpingora-586781a6850c86606171ad6dc17c0814e036bb83.tar.gz
pingora-586781a6850c86606171ad6dc17c0814e036bb83.zip
docs: add build requirements to README.md
Includes-commit: ba75f36b3963a5cc6fb02f518c283baf58d43c4d Replicated-from: https://github.com/cloudflare/pingora/pull/7
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
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).