From 818cb2cdeb51b5711643b47f2e9458c318c45c8b Mon Sep 17 00:00:00 2001 From: teor Date: Tue, 8 Mar 2022 19:14:03 +1000 Subject: [PATCH] doc(network): explain optional zebra-network/tor dependencies (#3765) * doc(network): explain optional zebra-network/tor dependencies * cleanup(doc): remove an extra newline --- book/src/user/install.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/book/src/user/install.md b/book/src/user/install.md index 42f81e7d6..251428fb2 100644 --- a/book/src/user/install.md +++ b/book/src/user/install.md @@ -18,14 +18,26 @@ that there is a lot of key functionality still missing. #### Build Troubleshooting If you're having trouble with: -- **dependencies:** - - install both `libclang` and `clang` - they are usually different packages - - use `cargo install` without `--locked` to build with the latest versions of each dependency + +Dependencies: +- use `cargo install` without `--locked` to build with the latest versions of each dependency +- **sqlite linker errors:** libsqlite3 is an optional dependency of the `zebra-network/tor` feature. + If you don't have it installed, you might see errors like `note: /usr/bin/ld: cannot find -lsqlite3`. + [Follow the arti instructions](https://gitlab.torproject.org/tpo/core/arti/-/blob/main/CONTRIBUTING.md#setting-up-your-development-environment) + to install libsqlite3, or use one of these commands instead: +```sh +cargo build +cargo build -p zebrad --all-features +``` + +Compilers: +- **clang:** install both `libclang` and `clang` - they are usually different packages - **libclang:** check out the [clang-sys documentation](https://github.com/KyleMayes/clang-sys#dependencies) - **g++ or MSVC++:** try using clang or Xcode instead -- **rustc:** use rustc 1.48 or later +- **rustc:** use rustc 1.58 or later - Zebra does not have a minimum supported Rust version (MSRV) policy yet + ### Dependencies Zebra primarily depends on pure Rust crates, and some Rust/C++ crates: