From f01834957e5ced9989969f28ff4c3e6f23b2bf29 Mon Sep 17 00:00:00 2001 From: Amrita Gupta Date: Wed, 18 Mar 2020 21:46:59 +0000 Subject: [PATCH 1/2] 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 From bcb0e2e212554160978f206970e0856508840eb2 Mon Sep 17 00:00:00 2001 From: Amrita Gupta Date: Wed, 18 Mar 2020 21:30:19 +0000 Subject: [PATCH 2/2] docs: fix URL rendering in README The endpoint was wrongly rendered as bold `heartbeat` instead of `__heartbeat__`. Let's fix this by escaping the `_`s. Closes #496 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c24ed2ed..58a41196 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ This currently requires access to the [mozilla-rust-sdk](https://github.com/mozi context: . ``` 5. Adjust the MySQL db creds in docker-compose.yml to match your local setup. -6. `make docker_start` - You can verify it's working by visiting [localhost:8000/__heartbeat__](http://localhost:8000/__heartbeat__) +6. `make docker_start` - You can verify it's working by visiting [localhost:8000/\_\_heartbeat\_\_](http://localhost:8000/__heartbeat__) ### Connecting to Firefox