From f01834957e5ced9989969f28ff4c3e6f23b2bf29 Mon Sep 17 00:00:00 2001 From: Amrita Gupta Date: Wed, 18 Mar 2020 21:46:59 +0000 Subject: [PATCH] docs: add system dependencies to README Closes #255 --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c24ed2ed..c6b56e2b 100644 --- a/README.md +++ b/README.md @@ -28,18 +28,21 @@ Mozilla Sync Storage built with [Rust](https://rust-lang.org). ## System Requirements +- cmake +- gcc +- [golang](https://golang.org/doc/install) +- libcurl4-openssl-dev +- libssl-dev +- make +- pkg-config - [Rust stable](https://rustup.rs) - MySQL 5.7 (or compatible) - -\* libmysqlclient (`brew install mysql` on macOS, `apt-get install libmysqlclient-dev` on Ubuntu) -- [Go](https://golang.org/doc/install) -- Cmake -- Pkg-config -- Openssl + * libmysqlclient (`brew install mysql` on macOS, `apt install libmysqlclient-dev` on Ubuntu) Depending on your OS, you may also need to install `libgrpcdev`, -`libcurl4-openssl-dev`, and `protobuf-compiler-grpc`. *Note*: if the -code complies cleanly, but generates a Segmentation Fault within -Sentry init, you probably are missing `libcurl4-openssl-dev`. +and `protobuf-compiler-grpc`. *Note*: if the code complies cleanly, +but generates a Segmentation Fault within Sentry init, you probably +are missing `libcurl4-openssl-dev`. ## Local Setup