Skip to content

Commit

Permalink
Update doc to install dylint-link tool. (#60)
Browse files Browse the repository at this point in the history
* adding doc to install dylint tool.

* rename Dylint to dylint-link it based on the cargo package

* Apply suggestions from code review

Co-authored-by: Michael Müller <mich@elmueller.net>
  • Loading branch information
darwinsubramaniam and cmichi authored May 6, 2022
1 parent 880331a commit 9441b53
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/getting-started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ The first tool we will be installing is [`cargo-contract`](https://github.com/pa

As a pre-requisite for the tool you need to install the [binaryen](https://github.com/WebAssembly/binaryen) package, which is used to optimize the WebAssembly bytecode of the contract.

Two other dependencies are needed to lint the ink! contract. This is done to warn users about using e.g. API's in a way that could lead to security issues.

```bash
cargo install cargo-dylint dylint-link
```

Many package managers have it available nowadays ‒ e.g. there is a package for [Debian/Ubuntu](https://tracker.debian.org/pkg/binaryen),
[Homebrew](https://formulae.brew.sh/formula/binaryen) and [Arch Linux](https://archlinux.org/packages/community/x86_64/binaryen/).

Expand Down

0 comments on commit 9441b53

Please sign in to comment.