From f84101418673290741a23b8060ebfe02aa16055d Mon Sep 17 00:00:00 2001 From: finga Date: Thu, 20 Aug 2020 11:16:58 +0200 Subject: [PATCH] doc: add Debian based setup to readme --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a699840c..3b8ed111 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # monster Monster is a symbolic execution engine for 64-bit RISC-V code -# toolchain setup (mac) - -1. Install rust +# Toolchain setup +## Install rust +1. Bootstrap rust ``` $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` @@ -12,7 +12,7 @@ $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh $ rustup component add rustfmt $ rustup component add clippy ``` -3. Add cargo to your PATH +3. Add cargo to your $PATH ``` $ echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.zshrc && source ~/.zshrc ``` @@ -20,11 +20,26 @@ $ echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.zshrc && source ~/.zshrc ``` $ cargo install cross ``` + +## Docker and llvm +### Debian based +5. Install docker (needed by cross) +``` +$ apt install docker +``` +6. Make sure you have a recent version of clang/llvm (>= v9) installed: +``` +$ apt intall llvm +``` + +### Mac 5. Install docker (needed by cross) with [this installation guide](https://docs.docker.com/docker-for-mac/install/) 6. Make sure you have a recent version of clang/llvm (>= v9) installed: ``` $ brew install llvm ``` + +## Build and test 7. Test your toolchain setup by compiling monster: ``` $ cargo build