From e2e3800a4354b466074fd73ed7d1abd3ab2d1716 Mon Sep 17 00:00:00 2001 From: Gareth Hayes Date: Tue, 26 Oct 2021 11:19:01 +0800 Subject: [PATCH] Problem: dependencies are not listed --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b1d2579b3..5aaf1e32b 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,29 @@ ## Build -To build the necessary binaries, we can just clone the repo, and use -the provided Makefile to build the project. This will download the -trusted setup params, and compile the source code. +This project requires the Rust compiler to be installed. +Please visit https://rustup.rs/ for instructions. + +The following dependencies are also required +|Dependency| Debian-based | +|---|---| +| gcc, gcc-c++, kernel headers| build-essential | +| clang | clang | +| clang libs | libclang-dev | +|llvm libs | llvm-dev | +| udev source | libudev-dev | +| pkg-config | pkg-config | + +Users of Debian-based systems (e.g. Ubuntu) can simply run the following +to install the required dependencies: +``` +$ sudo apt-get update +$ sudo apt-get install -y build-essential clang libclang-dev llvm-dev libudev-dev pkg-config +``` + +To build the necessary binaries, we can just clone the repo, and use the +provided Makefile to build the project. This will download the trusted +setup params, and compile the source code. ``` $ git clone https://github.com/darkrenaissance/darkfi