Skip to content

Commit

Permalink
doc: add Debian based setup to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
finga authored and ChristianMoesl committed Nov 17, 2020
1 parent 0a5493b commit f841014
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand All @@ -12,19 +12,34 @@ $ 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
```
4. Install tool for cross compilation
```
$ 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
Expand Down

0 comments on commit f841014

Please sign in to comment.